Skip to content

docs: add complete configuration reference table to README#160

Merged
jimisola merged 2 commits intomainfrom
fix/update-readme-configuration-table
Apr 19, 2026
Merged

docs: add complete configuration reference table to README#160
jimisola merged 2 commits intomainfrom
fix/update-readme-configuration-table

Conversation

@jimisola
Copy link
Copy Markdown
Member

Summary

  • Adds a complete configuration table documenting all 8 parameters with types, defaults, and descriptions
  • Adds a dataset directory reference table (requirements.yml, software_verification_cases.yml, manual_verification_results.yml)
  • Adds a full configuration example showing all parameters
  • Adds command-line override syntax (-Dreqstool.*)
  • Adds a goal reference section for assemble-and-attach-zip-artifact
  • Aligns README structure with reqstool-java-gradle-plugin

Adds a full configuration table documenting all plugin parameters with
types, defaults, and descriptions. Adds dataset directory reference,
full configuration example, command-line override syntax, and a goal
reference section. Aligns README structure with reqstool-java-gradle-plugin.

Signed-off-by: Jimisola Laursen <jimisola@jimisola.com>
… improvements

- Rewrite configuration.adoc with a reference table, dataset directory
  table, minimal/complete configuration examples, and command-line
  override syntax
- Update usage.adoc with goal reference, lifecycle diagram, and cleaner
  section structure
- Update index.adoc for consistent structure with Gradle plugin docs

Signed-off-by: Jimisola Laursen <jimisola@jimisola.com>
@jimisola jimisola self-assigned this Apr 19, 2026
@jimisola jimisola merged commit 2b1b29c into main Apr 19, 2026
8 checks passed
@jimisola jimisola deleted the fix/update-readme-configuration-table branch April 19, 2026 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant