Skip to content

Docs/cli overview top level index - #990

Open
BrandtH22 wants to merge 21 commits into
mainfrom
docs/cli-overview-top-level-index
Open

Docs/cli overview top level index#990
BrandtH22 wants to merge 21 commits into
mainfrom
docs/cli-overview-top-level-index

Conversation

@BrandtH22

@BrandtH22 BrandtH22 commented May 8, 2026

Copy link
Copy Markdown
Contributor

Note

Low Risk
Documentation-only changes to markdown and sidebar navigation; no runtime code or configuration behavior is modified.

Overview
This PR restructures the Chia CLI docs so the overview page mirrors the RPC reference pattern: global options, a CLI reference map (chain/farming, wallet, other), and a top-level command index linking each root chia command to on-site docs or chia -h.

New dedicated pages document farming stack CLIs with option tables, examples, and links to chia/cmds sources: Farmer (farm, plotnft, connect-solver), Full Node (show, netspace, peer full_node), Harvester (peer harvester, plot dirs, remote notes), Plots (show/add/remove/create/check), and Solver (get_state).

The overview delegates depth instead of duplicating it: long plots check and detailed plotnft prose move to Plots and Farmer CLI pages (a legacy #plots-check anchor remains on the overview). chia db sections gain structured upgrade/backup/validate docs with examples; configure, passphrase, and stop are documented on the overview.

Navigation and cross-links: sidebars.js registers the new pages; troubleshooting plots check points to Plots CLI; Solver RPC intro wording is tightened and tied to Farmer/Solver CLI helpers.

Reviewed by Cursor Bugbot for commit 0c22009. Bugbot is set up for automated code reviews on this repo. Configure here.

BrandtH22 and others added 4 commits May 6, 2026 14:38
Enumerate every root CLI group from chia/cmds/chia.py with summary and pointer (section, topic page, or -h). Replace underspecified Other commands section. Use explicit heading ids for in-page links. zh-Hans updates are left to Crowdin/l10n automation.

Fixes #477

Co-authored-by: Cursor <cursoragent@cursor.com>
… pages

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Comment thread docs/reference-client/cli-reference/cli.md Outdated
Comment thread docs/reference-client/cli-reference/cli.md Outdated
Comment thread docs/reference-client/cli-reference/cli.md Outdated
Comment thread docs/reference-client/cli-reference/cli.md Outdated
Comment thread docs/reference-client/cli-reference/cli.md Outdated
Comment thread docs/reference-client/cli-reference/full-node-cli.md Outdated
Comment thread docs/reference-client/cli-reference/harvester-cli.md Outdated
Comment thread docs/reference-client/cli-reference/harvester-cli.md Outdated
Comment thread docs/reference-client/cli-reference/harvester-cli.md
Comment thread docs/reference-client/cli-reference/solver-cli.md Outdated
Co-authored-by: Cursor <cursoragent@cursor.com>
Comment thread docs/reference-client/cli-reference/cli.md
BrandtH22 and others added 13 commits May 8, 2026 09:32
…esponse template

Co-authored-by: Cursor <cursoragent@cursor.com>
…hub sections

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
…wdin

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
…nses

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
… dict keys

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Comment thread docs/reference-client/cli-reference/farmer-cli.md Outdated
Comment thread docs/reference-client/cli-reference/farmer-cli.md
danieljperry
danieljperry previously approved these changes Aug 12, 2026

@danieljperry danieljperry left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I skimmed the reference again. Other than the minor comments, this looks fine. I'll approve and you can choose whether to add context to the comments or merge as is.

BrandtH22 and others added 3 commits August 12, 2026 09:01
…:port

Align the challenges Response with one challenge hash and ten signage-point indices, and note that connect-solver takes host:port rather than a node ID.

Co-authored-by: Cursor <cursoragent@cursor.com>
Keep hub fragment links working after plots check moved to plots-cli.

Co-authored-by: Cursor <cursoragent@cursor.com>
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.

2 participants