docs: fix CLI/doc drift — validate→doctor, 14 skills, SKILL.md paths, document all subcommands - #463
Open
zeyuyang42 wants to merge 1 commit into
Open
docs: fix CLI/doc drift — validate→doctor, 14 skills, SKILL.md paths, document all subcommands#463zeyuyang42 wants to merge 1 commit into
zeyuyang42 wants to merge 1 commit into
Conversation
… document all subcommands Audit of every doc surface against the actual clap CLI found: - AGENTS.md + plugin.json advertised a nonexistent `byetex validate`; the real command is `byetex doctor`. - "12 bundled skills" claimed in 9 places; the binary embeds 14 (build.rs enumerates skills/*/SKILL.md). - Stale flat skill paths `skills/<name>.md` → `skills/<name>/SKILL.md` (README, AGENTS.md, fidelity-rubric, byetex-using-warnings-json body). - README CLI section omitted `compile`, `render`, `review`, `explain`; added with real flags/defaults. - `byetex compile --help` claimed default `<input>.pdf`; compile_typ writes `<input-stem>.pdf` (with_extension) — fixed the doc comment. Co-Authored-By: Claude Fable 5 <[email protected]>
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
1 participant
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.
Summary
Full audit of every doc surface (README, AGENTS.md, docs/, bundled skills, plugin manifests) against the actual clap CLI in
crates/byetex-cli/src/main.rs, prompted by a reported README↔CLI mismatch. Fixes:byetex validateadvertised in AGENTS.md ("More commands") and.claude-plugin/plugin.json— the real command isbyetex doctor.docs/plugin-setup.md(×2),docs/getting-started.md,docs/test-plan.md(×2), and both plugin manifests.build.rsembeds everyskills/*/SKILL.md; there are 14.skills/<name>.md→skills/<name>/SKILL.mdin README, AGENTS.md,docs/fidelity-rubric.md, and thebyetex-using-warnings-jsonskill body.compile,render,review,explain(previously only in AGENTS.md) with their actual flags and defaults.byetex compile --helpdefault-path claim corrected:compile_typwrites<input-stem>.pdf(with_extension), not<input>.pdf.Verified unchanged/correct: every flag README documents, all referenced skill names,
docs/for-agents.md,install.sh,skills/INDEX.md, and thecargo installpackage name.Not touched (flagged for maintainer): plugin manifests still say
"version": "0.3.0"(workspace is 0.7.0) — left alone in case the plugin channel versions independently.Test plan
cargo test --workspacegreen in the worktree (with pinned-corpus symlinks fortemplate_budgets).🤖 Generated with Claude Code