Repository navigation
docs(site): regroup the sidebar and check the reference against the Rust build - #36
Merged
Merged
Conversation
…project Installation comes before the quick start, the recipes page gets entries for sharing code, working with changes and debugging a failed command, MCP moves to guides and security to project. No pages are added or moved.
With --rust-json docs/cli-matrix.json the check compares the option tables plus the binary-only headings (#### `--raw`, only in the binary) with the Rust build, and flags a binary-only option the Python build also has.
This was referenced Oct 22, 2026
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.
Tier: low
site/scripts/check_reference.pycan also check the reference against the Rust build (--rust-json docs/cli-matrix.json, the matrix from docs: generate a matrix of commands and options in each build #35).Stacked on #34 (base
docs/home-redesign).Changes
Checked against the CLI
####--raw, only in the binaryundercdg term). The check now reads those headings, and with--rust-jsoncompares the tables plus those headings with the"rust"key ofdocs/cli-matrix.json(generated from clap in docs: generate a matrix of commands and options in each build #35, hidden options included).uv run python site/scripts/check_reference.py --rust-json docs/cli-matrix.jsonwith the matrix from docs: generate a matrix of commands and options in each build #35: "reference matches the CLI: 21 commands, 107 options; Rust build: 108 options". Without the flag: "21 commands, 107 options", as before.--rawheading fails with "option --raw of the Rust build is not documented"; adding--rawto the Korean table fails with "documents --raw, which the Python build does not have".-Vfor the version only in Rust, is a root option and outside the per-command tables.--rust-json docs/cli-matrix.jsonto the check step indocs.yml. It is not wired here, so this PR does not depend on docs: generate a matrix of commands and options in each build #35.ruff checkandruff format --checkpass.Validation
npm run buildpasses; internal links: one known broken anchor, fixed by fix(site): link the Korean install section by an ASCII id #32.Screenshots