Skip to content

docs: align content with SwissKnife v0.2.0#9

Merged
darioAnongba merged 2 commits into
mainfrom
docs/align-v0.2.0
Jun 18, 2026
Merged

docs: align content with SwissKnife v0.2.0#9
darioAnongba merged 2 commits into
mainfrom
docs/align-v0.2.0

Conversation

@darioAnongba

Copy link
Copy Markdown
Contributor

Summary

Aligns the documentation content with the current SwissKnife v0.2.0 (companion to the dependency upgrade in #8). Produced by auditing all 21 doc pages against the live SwissKnife sources — CHANGELOG.md, config/default.toml, the OpenAPI spec, the Dockerfiles, README.md, and the backend source — then applying the fixes per file.

What changed (14 pages + announcement bar)

  • Lightning providers — removed discontinued Breez / Greenlight / Liquid / Spark (and never-supported Phoenix / Lightspark); documented Core Lightning and LND, each over gRPC and REST; fixed ln_provider values (cln_grpc / cln_rest / lnd_grpc / lnd_rest); noted base64-encoded macaroon support.
  • On-chain Bitcoin wallet — added across features / intro / config / usage (address management, wallet sync, transaction preparation; bitcoin_address_type, /v1/bitcoin/addresses).
  • Configuration — replaced the stale embedded default.toml; corrected the auth table (the admin password is set via the sign-up flow, not config); added lnd_grpc_config, bitcoin_address_type, dashboard_dir, database.url / busy_timeout; removed nonexistent keys (retry_delay, ws_*_reconnect_delay); documented OAuth2/OIDC discovery; corrected DB support (PostgreSQL + SQLite, SQLite is the default).
  • Deployment — replaced the "private registry" page with the public Docker Hub images (swissknife :3000 bundle, swissknife-server :3000, swissknife-dashboard :8080), tags, build targets, and the Kubernetes image split.
  • Developers — fixed the broken github.com/swissknife/issues link; marked webhooks clearly as not-yet-available (no webhook API exists in v0.2.0).
  • Authored two guidesswissknife/usage (sign-in, balance, receive over Lightning invoice / address / LNURL / Nostr / on-chain, send, on-chain wallet, API keys — every endpoint, scope, and field verified against the OpenAPI spec) and swissknife/architecture (layered/DDD design, the provider abstraction, persistence, auth, the HTTP server + event listener, deployment topology).
  • Other — announcement bar bumped to v0.2.0; removed present-tense RGB / smart-contract claims.

Left intact (by decision)

  • docs/account/* and the hosted "Numeraire Account" framing in introduction.md — these document the real hosted Numeraire SaaS (app.numeraire.tech), not the self-hosted software.

Verification

yarn build passes (Docusaurus — no broken links, no MDX errors). The authored usage guide's API claims were spot-checked against openapi.json (endpoint paths, Balance fields incl. fees_paid_msat, the permission scopes, and the case-insensitive api-key header).

Notes / follow-up

  • The audit surfaced a code bug in swissknife/Makefile: the run-docker target maps 5000:5000 but the app binds 3000 — worth a separate fix in the swissknife repo. The docs now show the correct -p 3000:3000.
  • Merge after build(deps): upgrade Docusaurus 3.10, React 19, eslint 9 flat config #8 (the deps upgrade) or rebase onto it; the content builds on both Docusaurus 3.5 and 3.10.

Closes #7.

Remove discontinued LN providers (Breez/Liquid/Spark); document CLN+LND over gRPC/REST, the on-chain Bitcoin wallet, base64 macaroons, and OAuth2/OIDC; refresh config + deployment (public Docker Hub images/ports); author usage + architecture guides; drop RGB/smart-contract claims. Hosted Numeraire Account docs left intact.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 90f3a8e29f

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/swissknife/usage/index.mdx
@darioAnongba darioAnongba self-assigned this Jun 18, 2026
@darioAnongba darioAnongba merged commit 909913b into main Jun 18, 2026
1 check passed
@darioAnongba darioAnongba deleted the docs/align-v0.2.0 branch June 18, 2026 17:41
@darioAnongba darioAnongba mentioned this pull request Jun 18, 2026
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.

Align documentation with SwissKnife 0.1.8 release changes

1 participant