Repository navigation
docs: align Reference groups across tabs and rebuild CLI docs from source - #33
Merged
Merged
Conversation
…urce Every product tab now opens with Overview / Installation / Getting Started and closes with the same Reference group. The CLI and API Reference tabs were the only two missing the FAQ / Troubleshooting / Additional Resources trio; both now have it, and Installation is split out of Getting Started for the CLI and the SDK. The CLI tab is verified against the kaleido-cli source (v0.1.1) rather than its README, which fixes several inaccuracies: - Documents `node unlock --chain-sync block|transaction` and the three service profiles, previously undocumented - Corrects the install path: the CLI is not on PyPI, so `pip install` cannot work; the one-line bootstrap installer is now the primary route - Records the display-vs-raw amount split (`market quote` and `swap atomic` take display units, `asset` and `payment` take raw) and the per-command layer sets - Drops the `swap order` group from the copy, since it no longer exists - Fixes `asset send-batch` (takes a JSON file path), `channel close` (`--force`), `wallet create-utxos` flags, and ~20 further flag gaps - New Troubleshooting is built on the CLI's actual error strings - Renames nav groups and page labels for cross-tab consistency Error Handling pages are folded into Troubleshooting under an `#error-reference` section, and the standalone pages are removed. All changes are mirrored in the Simplified Chinese tree. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
- redirect /api-reference/error-handling (+ /cn) to troubleshooting, matching the sdk redirects for the other deleted page - drop the deleted error-handling.mdx entries from the README file inventory and list the API Reference tab's current 9 pages - normalize two relative links in cn channel-requests to /cn/ paths Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
bitwalt
added a commit
that referenced
this pull request
Sep 1, 2026
…nto the en nav Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
What changed
Two things, one structural and one factual.
Structure. Every product tab now opens with
Overview / Installation / Getting Startedand closes with the sameReferencegroup. The CLI and API Reference tabs were the only two missing the FAQ / Troubleshooting / Additional Resources trio — both now have it, in English and Simplified Chinese.Installationis split out ofGetting Startedfor the CLI and the SDK. The standalone Error Handling pages are folded into each tab's Troubleshooting under an#error-referencesection.Facts. The CLI tab was rewritten against the
kaleido-clisource (v0.1.1,master) instead of its README, which surfaced several errors in the existing copy:pip installnode unlockoptions list--chain-sync block|transactionand the signet / regtest / custom profilesswap ordergroupasset send-batchwith no argumentchannel closewith--peeronly--forcefor a unilateral closecreate-utxosmissing--num/--size--up-tosemanticsmarket quoteandswap atomictake display units;assetandpaymenttake raw integersBTC_ONCHAINfor quotes,BTC_L1/RGB_L1for atomic swapsAround 20 further missing flags were added to the CLI command reference, and the new Troubleshooting page is built on the CLI's actual error strings (
Docker is not installed or not in PATH.,Multiple environments exist — specify one:,Swapstring must contain 6 slash-separated fields., and so on) rather than paraphrases.CLI nav labels were also tightened for cross-tab consistency: groups
Node OperationsandChannels & Trading, pagesEnvironments,Wallet & Assets,Channels & LSP,Market & Swaps,Commands.Why
The CLI tab was the only tab with no FAQ, no Troubleshooting and no Additional Resources, and the only one with zero outbound links to other tabs despite nine inbound ones. It was also drifting from the source: the README it was based on is itself stale in places (its PyPI badge points at a package that returns 404, and it documents the removed
swap ordergroup).Verification
docs.jsonparses; 175 pages on disk, all present in navigation and vice versaFor the reviewer
whats-kaleidoswap/architecture.mdx:195links to/whats-kaleidoswap/glossary#bitcoin-layers-%26-assets, but the target heading is## Bitcoin Layers & Assets, whose slug drops the&. The Chinese side already does this correctly with an explicit{#bitcoin-layers-and-assets}slug — the English side should match. Left alone to keep this PR's scope clean.kaleidoswap/kaleido-cliwhile cross-checking, and are not fixable here: the stale PyPI badge, the documented-but-removedswap ordergroup, a--service bitcoindexample naming a service the generated compose file never creates, and--from-amount 100000examples that treat display units as satoshis (also inonboarding.py). Worth a separate issue on that repo.Wallet, Assets, And Payments,Channels And LSP Flows,Market And Swaps), a style that appears nowhere else in the docs. The sidebar labels are fixed; the H1s were left alone because they are SEO titles.🤖 Generated with Claude Code