Repository navigation
docs(cli): document every command, and check it in CI - #5938
Conversation
Both command groups are registered and visible but had no section in the CLI reference. - media-use: subcommands, resolve flags, the per-type source order, where files land, which sources need a HeyGen sign-in or can cost money, and telemetry. - usage: flags, the known and unknown result shapes, which logins it reads, and that it sends no telemetry. - Add both to the "Find your command" table. The from, reuse, and params subcommands cannot take their value in this release, so the page points to the working resolve --from, --reuse, and --params forms instead. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
The bugs go to the media-use owner instead of living in the docs. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
A ~20-line check fails the docs workflow when a CLI command is missing from "Find your command". On main it finds media-use, usage, models, clean and events. AGENTS.md and CLAUDE.md ask agents to ship docs with the change. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
ukimsanov
changed the title
jrusso1020
left a comment
jrusso1020
left a comment
There was a problem hiding this comment.
The finder now covers all 49 top-level command loaders, and .github/workflows/docs.yml triggers when either the loader map or checker changes. I executed scripts/check-docs-cli-commands.mjs: current docs pass; deleting the media-use finder entry or adding a synthetic undocumented command each fails.
I checked the added media-use/usage sections against the exact-head command implementations and relevant engine/credential paths. The examples use resolve --from/--reuse rather than the known broken positional variants. Usage’s read-only credential paths, fixed provider endpoints, redirect refusal and telemetry/update-check exclusions agree with the documentation. No actual credentials were read and no paid/media-provider calls were made.
Limitations: the checker establishes finder membership, not that every linked section remains semantically complete; it does not execute examples. No full Mintlify build, complete CLI suite or end-to-end media resolution was run. The pre-existing CLI manual outside the changed sections was not revalidated command by command.
Verdict: COMMENT
Reasoning: No blocking mismatch found in the new documentation or command-finder check. Approval needs James’s go or a trusted stamper’s request.
— hf-review
jrusso1020
left a comment
jrusso1020
left a comment
There was a problem hiding this comment.
Approval at exact head 7db6b1bdf59de8f804b41fefd3d61f1e2d76d3d3, unchanged since my code review. James directly authorized approval in the originating Slack thread; no new code findings were added in the refreshed review/comment history.
New media-use/usage documentation agrees with the inspected implementations. The finder check covers all 49 command loaders and fails on an omitted entry or synthetic undocumented command.
Validation and limits: Checker and source controls; no full docs build, media-provider call or complete CLI suite. Finder membership does not certify semantic completeness of every section.
Verdict: APPROVE
Reasoning: The reviewed code remains clear under the stated scope and collection contract; earlier blocking findings are resolved where applicable. No merge, deployment or publication performed by me.
— hf-review
What
Every CLI command is documented, and CI keeps it that way.
media-use(9 subcommands) andusage. Both are visible commands the skills tell agents to run, and the docs had nothing on them.media-use,usage,models,cleanandevents. The last three had sections but weren't in the finder.scripts/check-docs-cli-commands.mjs(~20 lines), run in the docs workflow. It fails when a command incli.ts'scommandLoadersis missing from "Find your command". The workflow now also runs whenpackages/cli/src/cli.tschanges.docs/in the same PR.Why
Commands shipped without docs (
media-use,usage) and nobody noticed. Agents read these pages, so a missing command means an agent can't find it. The check covers the direction that actually drifted. An earlier, larger proposal (#5933) checked every flag shown in the docs against the CLI, but it found 0 errors in today's docs.How
Every documented
media-use/usageflag and subcommand was run from source, except the network-dependentresolvetypes (bgm, image, icon, logo, voice, video), which were checked against the code.Found while running them, not fixed here, to be reported to the
media-useowner:from/reuse/paramssubcommands reject their value; the short flags-t/-i/-eand--sourceare rejected;media-use resolve --helphas no descriptions; root--helpdoesn't listmedia-use,usage,figmaorevents; andguides/authentication.mdxgives the wrong SFX order. The docs page uses only the forms that work.Test plan
node scripts/check-docs-cli-commands.mjs: all 49 commands listed. On main'scli.mdxit fails withmedia-use, usage, models, clean, events.mint validate;mint broken-links --check-redirectsclean