Skip to content

docs: align Reference groups across tabs and rebuild CLI docs from source - #33

Merged
bitwalt merged 2 commits into
mainfrom
fix/general-update
Sep 1, 2026
Merged

bitwalt merged 2 commits into
mainfrom
fix/general-update

Conversation

@jelleml

@jelleml jelleml commented Aug 17, 2026

Copy link
Copy Markdown
Member

What changed

Two things, one structural and one factual.

Structure. 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, in English and Simplified Chinese. Installation is split out of Getting Started for the CLI and the SDK. The standalone Error Handling pages are folded into each tab's Troubleshooting under an #error-reference section.

Facts. The CLI tab was rewritten against the kaleido-cli source (v0.1.1, master) instead of its README, which surfaced several errors in the existing copy:

Was Now
Suggested pip install The CLI is not on PyPI; installs from source, bootstrap installer first
node unlock options list Adds --chain-sync block|transaction and the signet / regtest / custom profiles
Described a swap order group Removed — it no longer exists in the CLI
asset send-batch with no argument Takes a JSON file path
channel close with --peer only Also --force for a unilateral close
create-utxos missing --num / --size Full flag table, including --up-to semantics
Amount units unstated market quote and swap atomic take display units; asset and payment take raw integers
One layer set documented Per-command sets: BTC_ONCHAIN for quotes, BTC_L1 / RGB_L1 for atomic swaps

Around 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 Operations and Channels & Trading, pages Environments, 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 order group).

Verification

  • docs.json parses; 175 pages on disk, all present in navigation and vice versa
  • No broken internal page links, and no broken heading anchors, except one noted below
  • English and Chinese CLI pages checked for table-row parity

For the reviewer

  • One known broken anchor, pre-existing and not touched here: whats-kaleidoswap/architecture.mdx:195 links 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.
  • Four inconsistencies were found upstream in kaleidoswap/kaleido-cli while cross-checking, and are not fixable here: the stale PyPI badge, the documented-but-removed swap order group, a --service bitcoind example naming a service the generated compose file never creates, and --from-amount 100000 examples that treat display units as satoshis (also in onboarding.py). Worth a separate issue on that repo.
  • Three CLI page H1s still capitalise "And" (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

jelleml and others added 2 commits August 17, 2026 16:29
…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
bitwalt merged commit d6ffb37 into main Sep 1, 2026
4 checks passed
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>
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