docs: exhaustive usage.md — document all CLI flags, config keys, and GitLab CI/CD snippet#95
Conversation
Updated the GitHub Action section to provide a more concise integration guide and removed unnecessary code snippets.
|
@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. |
Done. The README |
docs/usage.mdwas missing most CLI flags and config options. The README duplicated what little was there, creating a maintenance split. This PR makesusage.mdthe single authoritative reference and points the README to it.docs/usage.md--skip-somef,--verbose,--threshold,--generate-codemeta,--notes-output, and all output-path flags (--somef-output,--pitfalls-output,--analysis-output) — each with a runnable exampleactive_profilekey,rsmetacheck.toml(no-dot) as an alternate auto-detected filename, and a complete TOML example covering all supported keysRsMetaCheck→RSMetaCheckcapitalisationREADME.mdReplaces 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.