Skip to content

docs: exhaustive usage.md — document all CLI flags, config keys, and GitLab CI/CD snippet#95

Merged
Anas-Elhounsri merged 6 commits into
mainfrom
copilot/add-gitlab-ci-cd-snippet
Jun 4, 2026
Merged

docs: exhaustive usage.md — document all CLI flags, config keys, and GitLab CI/CD snippet#95
Anas-Elhounsri merged 6 commits into
mainfrom
copilot/add-gitlab-ci-cd-snippet

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jun 4, 2026

docs/usage.md was missing most CLI flags and config options. The README duplicated what little was there, creating a maintenance split. This PR makes usage.md the single authoritative reference and points the README to it.

docs/usage.md

  • New CLI sections: --skip-somef, --verbose, --threshold, --generate-codemeta, --notes-output, and all output-path flags (--somef-output, --pitfalls-output, --analysis-output) — each with a runnable example
  • Output paths table: consolidates all four output flags with their defaults at a glance
  • Version discrepancy notes: explains the note-vs-pitfall threshold with a sample notes JSON and corrected boundary examples
  • Multiple-URL input: documents passing several URLs directly on the command line (without a JSON file)
  • Config section: adds active_profile key, rsmetacheck.toml (no-dot) as an alternate auto-detected filename, and a complete TOML example covering all supported keys
  • GitLab CI/CD: adds an explicit snippet for the recommended GitHub-token variant alongside the minimal one; fixes RsMetaCheckRSMetaCheck capitalisation

README.md

Replaces the duplicated Usage section (CLI details, CI snippets, config examples) with a single sentence linking to the ReadTheDocs usage page — one place to maintain going forward.

Copilot AI changed the title [WIP] Add GitLab CI/CD snippet for RSMetaCheck docs: add GitLab CI/CD snippet for running RSMetaCheck on user repos Jun 4, 2026
Copilot AI requested a review from vuillaut June 4, 2026 09:52
Updated the GitHub Action section to provide a more concise integration guide and removed unnecessary code snippets.
@vuillaut
Copy link
Copy Markdown
Collaborator

vuillaut commented Jun 4, 2026

@copilot rework the documentation (README and usage.md) to have a single reference to point to where everything is explain (usage.md) and in readme just mention usage documentation and refer to it.
This way we have a single location in the documentation to maintain.

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Jun 4, 2026

@copilot rework the documentation (README and usage.md) to have a single reference to point to where everything is explain (usage.md) and in readme just mention usage documentation and refer to it.
T...

Done. The README Usage section now contains a single sentence pointing to the usage documentation (commit docs: replace README Usage section with link to usage documentation). All detailed content — CLI options, GitHub Action, GitLab CI/CD, output format, and configuration — lives exclusively in docs/usage.md.

Copilot AI changed the title docs: add GitLab CI/CD snippet for running RSMetaCheck on user repos docs: exhaustive usage.md — document all CLI flags, config keys, and GitLab CI/CD snippet Jun 4, 2026
@vuillaut vuillaut marked this pull request as ready for review June 4, 2026 10:33
@Anas-Elhounsri Anas-Elhounsri merged commit 678d5e6 into main Jun 4, 2026
2 checks passed
@vuillaut vuillaut deleted the copilot/add-gitlab-ci-cd-snippet branch June 4, 2026 12:20
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.

Add a gitlab CI/CD snippet to run RSMetaCheck on user repo

3 participants