docs: align content with SwissKnife v0.2.0#9
Merged
Conversation
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.
There was a problem hiding this comment.
💡 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".
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.
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)
ln_providervalues (cln_grpc/cln_rest/lnd_grpc/lnd_rest); noted base64-encoded macaroon support.bitcoin_address_type,/v1/bitcoin/addresses).default.toml; corrected the auth table (the admin password is set via the sign-up flow, not config); addedlnd_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).swissknife:3000 bundle,swissknife-server:3000,swissknife-dashboard:8080), tags, build targets, and the Kubernetes image split.github.com/swissknife/issueslink; marked webhooks clearly as not-yet-available (no webhook API exists in v0.2.0).swissknife/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) andswissknife/architecture(layered/DDD design, the provider abstraction, persistence, auth, the HTTP server + event listener, deployment topology).v0.2.0; removed present-tense RGB / smart-contract claims.Left intact (by decision)
docs/account/*and the hosted "Numeraire Account" framing inintroduction.md— these document the real hosted Numeraire SaaS (app.numeraire.tech), not the self-hosted software.Verification
✅
yarn buildpasses (Docusaurus — no broken links, no MDX errors). The authored usage guide's API claims were spot-checked againstopenapi.json(endpoint paths,Balancefields incl.fees_paid_msat, the permission scopes, and the case-insensitiveapi-keyheader).Notes / follow-up
swissknife/Makefile: therun-dockertarget maps5000:5000but the app binds3000— worth a separate fix in the swissknife repo. The docs now show the correct-p 3000:3000.Closes #7.