Skip to content

docs(book): walkthroughs for 42 user-facing CLI commands (BOOK-CLOSEOUT-001 follow-up)#1904

Merged
noahgift merged 4 commits into
feat/book-completeness-specfrom
feat/book-cli-walkthroughs-batch1
May 23, 2026
Merged

docs(book): walkthroughs for 42 user-facing CLI commands (BOOK-CLOSEOUT-001 follow-up)#1904
noahgift merged 4 commits into
feat/book-completeness-specfrom
feat/book-cli-walkthroughs-batch1

Conversation

@noahgift
Copy link
Copy Markdown
Contributor

Summary

Expands 42 high-value CLI chapter stubs in book/src/cli/*.md from ~25-line placeholders into 65-81 line walkthroughs. Each chapter now ships:

  • What this does — 2-3 sentences on purpose and audience
  • Key flags — 3-7 most-used flags in a markdown table
  • Common workflows — two end-to-end recipes using real qwen2.5-coder-* model names
  • Troubleshooting — 2-3 common errors with fixes, citing real GitHub issues where applicable

The existing PCU header, category line, synopsis block, fenced bash example, and See-also section are preserved verbatim. Total: 1,862 lines added across 42 files in 4 conventional commits.

Chapters covered (42)

  • Inference (4): run, chat, serve, code
  • Inspection (10): inspect, validate, lint, tensors, hex, tree, flow, explain, debug, trace
  • Quality (9): qa, qualify, check, bench, eval, canary, parity, profile, compare-hf
  • Transform (7): convert, export, import, quantize, merge, prune, compile
  • Registry (5): pull, list, rm, gpu, registry
  • Training (7): finetune, distill, train, pretrain, tokenize, tune, data

Quality gates

  • mdbook build — clean (no broken markdown, search index built)
  • mdbook-linkcheck --standalone — zero new errors from book/src/cli/*.md; pre-existing chapters/chN-*.md ../../../contracts/ errors are unrelated
  • Namespace Discipline grep — zero TODO / TBD / WIP / coming soon / under construction across all 42 files
  • Spec compliance — every chapter has exactly the required sections, line count 60-150

Notes

Test plan

  • cd book && mdbook build builds clean
  • mdbook-linkcheck --standalone reports no new errors from cli/*.md
  • Spot-check 3-5 chapters render correctly in the served book
  • Confirm "Namespace Discipline" CI gate passes (no forbidden words)
  • Author review for tone/accuracy

noahgift and others added 4 commits May 23, 2026 18:13
…ct, validate, lint, tensors, hex, tree, flow, explain, debug, trace (Refs #1902)

Adds "What this does", "Key flags", "Common workflows", and
"Troubleshooting" sections to 14 inference and inspection CLI chapters.
Each chapter now 60-150 lines (was ~25). Keeps existing PCU header,
bash example, and See-also block intact.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
…al, canary, parity, profile, compare-hf (Refs #1902)

Adds "What this does", "Key flags", "Common workflows", and
"Troubleshooting" sections to 9 quality / evaluation CLI chapters.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
…tize, merge, prune, compile (Refs #1902)

Adds "What this does", "Key flags", "Common workflows", and
"Troubleshooting" sections to 7 model-transform CLI chapters.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
…, finetune, distill, train, pretrain, tokenize, tune, data (Refs #1902)

Adds "What this does", "Key flags", "Common workflows", and
"Troubleshooting" sections to the 5 registry chapters and the 7 training
chapters. Completes the 42-chapter walkthrough batch.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@noahgift noahgift changed the base branch from main to feat/book-completeness-spec May 23, 2026 16:25
@noahgift noahgift merged commit a350893 into feat/book-completeness-spec May 23, 2026
13 checks passed
@noahgift noahgift deleted the feat/book-cli-walkthroughs-batch1 branch May 23, 2026 16:26
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.

1 participant