docs(basectl): add basectl node operator CLI docs - #1779
Open
Pulsator01 wants to merge 1 commit into
Open
Conversation
Add a basectl subgroup under Chain > Node Operators covering the interactive monitor, block and sync inspection, p2p, txpool, conductor/sequencer, doctor, and proofs. Cross-link basectl from Run a Base node.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Collaborator
🟡 Heimdall Review Status
|
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.
What changed? Why?
Adds documentation for
basectl, the Base node operator CLI (it ships in thebase/nodestack but wasn't on docs.base.org yet). Creates abasectlsubgroup under Chain > Node Operators with eight pages: overview, monitor (interactive TUI), blocks & sync, p2p, txpool, sequencer clusters (conductor/sequencer), doctor, and proofs. Also cross-links basectl from Run a Base node.Notes to reviewers
bin/basectl/README.mdinbase/basebaseup(the official installer for the verified release binaries) and thebase/nodeDocker image; the build-from-source option uses the samemaxperfprofile the release binaries are built with.How has it been tested?
node scripts/lint-mdx.js docs/base-chain/node-operators/basectl— 0 warnings. The remaining "missing language specifier" errors are the linter's known false positive on closing code fences (also present on existing pages likesnapshots.mdx).docs.jsonis valid JSON and every new nav entry resolves to a file.cd docs && npx mint dev.