Docs/cli overview top level index#990
Open
BrandtH22 wants to merge 18 commits into
Open
Conversation
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>
BrandtH22
commented
May 8, 2026
Co-authored-by: Cursor <cursoragent@cursor.com>
BrandtH22
commented
May 8, 2026
| <details> | ||
| <summary>Example</summary> | ||
|
|
||
| ## [Plots check](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/plotting/check_plots.py) |
Contributor
Author
There was a problem hiding this comment.
Are we removing this anchor and thereby breaking a link?
Co-authored-by: Cursor <cursoragent@cursor.com>
…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>
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>
|
|
||
| ````mdx-code-block | ||
| ```text | ||
| Hash: 0xa1b2c3d4e5f6789012345678901234567890abcd1234567890abcd1234567890 Index: 42 |
Contributor
There was a problem hiding this comment.
It's not a huge deal, but this response isn't realistic. For starters, the request asked for 10 lines, but the response only shows 2. In addition, the hash should be the same for those indices. This is actually a common confusion in our terminology. A single challenge has 64 signage points, indexed from 0 to 63. This shows consecutive signage points as if they were different challenges. And it's common for people to misidentify the signage points as challenges.
|
|
||
| ````mdx-code-block | ||
| ```bash | ||
| chia farm connect-solver 192.0.2.10:8666 |
Contributor
There was a problem hiding this comment.
Just a side note that I wonder if it's possible to connect to a specific node ID rather than an IP address. This is allowed for normal peers, so maybe it should be allowed here as well.
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
2 participants
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.
Note
Low Risk
Documentation-only changes that restructure and add CLI reference content; risk is limited to broken links/anchors or navigation ordering in the docs site.
Overview
Refactors
CLI Overviewinto an entry-point page with global options, a CLI reference map, and a top-level command index, and expands coverage forplotnft,plots,db(upgrade/backup/validate),configure,passphrase, andstopwith clearer anchors and examples.Adds new service-focused CLI reference pages for Full Node, Farmer, Harvester, Plots, and Solver, and wires them into
sidebars.js; also updates a troubleshooting link to point to the newplots checkdocs and makes a small wording/link tweak insolver-rpc.md.Reviewed by Cursor Bugbot for commit 4cfe7bb. Bugbot is set up for automated code reviews on this repo. Configure here.