Skip to content

Fix usethis show docs gaps and add CLI doc integrity skill#1813

Merged
nathanjmcdougall merged 2 commits into
mainfrom
copilot/update-docs-cli-reference
Apr 4, 2026
Merged

Fix usethis show docs gaps and add CLI doc integrity skill#1813
nathanjmcdougall merged 2 commits into
mainfrom
copilot/update-docs-cli-reference

Conversation

Copilot AI commented Apr 4, 2026

Copy link
Copy Markdown
Contributor

docs/cli/reference.md had drifted from the code in the usethis show section: usethis show license was absent from the subcommand list, --output-file was documented only under sonarqube despite applying to all four show subcommands, and --project-key was undocumented.

Changes

docs/cli/reference.md

  • Add usethis show license to the subcommand inventory
  • Promote --output-file to the parent usethis show section (shared by all subcommands)
  • Document --project-key in the usethis show sonarqube subsection as its only command-specific option

usethis-cli-modify skill (v1.4 → v1.5)

  • Add explicit guidance to cross-check every option parameter in modified command signatures against the reference docs — shared options (defined once, reused across commands) are the most common miss
  • Reference the new usethis-qa-doc-integrity skill for systematic audits

New usethis-qa-doc-integrity skill (v1.0)

  • Procedure for auditing CLI doc coverage: compare _ui/interface/ signatures against docs/cli/reference.md
  • Calls out the three gap categories: missing options, missing subcommands, stale entries
  • Documents when shared options may be documented at group level vs. per-subcommand

Copilot AI changed the title [WIP] Update docs/cli/reference.md for new CLI flag --output-file Fix usethis show docs gaps and add CLI doc integrity skill Apr 4, 2026
Copilot AI requested a review from nathanjmcdougall April 4, 2026 08:53
@nathanjmcdougall nathanjmcdougall marked this pull request as ready for review April 4, 2026 09:09
@nathanjmcdougall nathanjmcdougall merged commit aae2f71 into main Apr 4, 2026
1 check passed
@nathanjmcdougall nathanjmcdougall deleted the copilot/update-docs-cli-reference branch April 4, 2026 09:11
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.

lesson: always update docs/cli/reference.md when adding new CLI flags

2 participants