docs(cli): add missing subcommands to quick references#397
Merged
Alberto-Codes merged 1 commit intomainfrom Mar 27, 2026
Merged
docs(cli): add missing subcommands to quick references#397Alberto-Codes merged 1 commit intomainfrom
Alberto-Codes merged 1 commit intomainfrom
Conversation
…rences The fix, config, lsp, mcp, and presence subcommands were shipped but never added to the quick reference tables in README.md and CLAUDE.md. Also adds freshness --mode drift to both references. Closes #396
There was a problem hiding this comment.
Pull request overview
This PR closes a documentation discoverability gap by updating the “quick reference” sections (README and CLAUDE) to reflect the actual docvet CLI surface area, aligning them with the already-complete CLI reference docs.
Changes:
- Add missing quick-reference entries for
fix(including--dry-run),config,lsp, andmcp. - Add
presenceto CLAUDE.md’s command list. - Add
freshness --mode driftto both quick references.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Extends the subcommand quick reference table to include freshness --mode drift, fix (+ --dry-run), config, lsp, and mcp. |
| CLAUDE.md | Updates the CLI command list to include presence, freshness --mode drift, fix (+ --dry-run), config, lsp, and mcp. |
Alberto-Codes
added a commit
that referenced
this pull request
Mar 27, 2026
🤖 I have created a release *beep* *boop* --- ## [1.15.0](v1.14.1...v1.15.0) (2026-03-27) ### Features * **cli:** add docvet fix subcommand with dry-run and discovery ([#386](#386)) ([7f76477](7f76477)) * **cli:** add inline suppression comments for findings ([#393](#393)) ([14ba0b7](14ba0b7)) * **enrichment:** add scaffold category, scaffolding engine, and scaffold-incomplete rule ([#385](#385)) ([782cd27](782cd27)) * **enrichment:** add scaffold-incomplete enrichment rule ([782cd27](782cd27)) ### Bug Fixes * **cli:** address code review findings for fix subcommand ([7f76477](7f76477)) * **cli:** prevent uppercase rule IDs from degrading to blanket ([14ba0b7](14ba0b7)) * **config:** address PR [#379](#379) review feedback ([#380](#380)) ([134e428](134e428)) * **enrichment:** handle docstring-only stubs, multi-statement stubs, and deprecated abstract decorators ([#391](#391)) ([bc2445d](bc2445d)), closes [#387](#387) [#388](#388) [#389](#389) * **griffe:** replace production assert, fix dep vulns, add vuln handling docs ([#395](#395)) ([7273e56](7273e56)) * **test:** move _active_style reset to shared conftest fixture ([#363](#363)) ([b8b6586](b8b6586)) ### Documentation * **cli:** add missing subcommands to quick references ([#397](#397)) ([d92af72](d92af72)), closes [#396](#396) * **enrichment:** add scaffold-incomplete rule page and config docs ([782cd27](782cd27)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A systematic code-vs-docs audit revealed that five subcommands shipped
without being added to the quick reference sections in README.md and
CLAUDE.md. The CLI reference page already documented them, but users
scanning the README or AI agents reading CLAUDE.md couldn't discover
fix,config,lsp,mcp, orpresence.fix,fix --dry-run,config,lsp,mcpto README subcommand tablepresence,fix,fix --dry-run,config,lsp,mcpto CLAUDE.md commandsfreshness --mode driftto both quick referencesTest: CI only (docs-only change)
Closes #396
PR Review
Checklist
uv run pytest)uv run ruff check .)uv run ty check)!in title andBREAKING CHANGE:in bodyReview Focus
Verify the quick reference entries match the actual CLI surface. The CLI reference page (
docs/site/cli-reference.md) already had full documentation for all subcommands — this PR closes the gap in the two quick-reference locations.Related
Issue #396 — systematic audit of undocumented CLI features