Repository navigation
docs: add wallet and webhook guides and dry-run every documented change - #26
Open
thebrandonlucas wants to merge 1 commit into
Open
thebrandonlucas wants to merge 1 commit into
thebrandonlucas wants to merge 1 commit into
Conversation
thebrandonlucas
added this pull request to stack #25
October 13, 2026 19:00
This was referenced Oct 13, 2026
thebrandonlucas
force-pushed
the
docs/cli-guides
branch
from
October 19, 2026 13:14
5006334 to
cf61a4b
Compare
thebrandonlucas
force-pushed
the
docs/cli-guides
branch
from
October 19, 2026 13:15
cf61a4b to
8133299
Compare
thebrandonlucas
force-pushed
the
docs/cli-guides
branch
3 times, most recently
from
October 19, 2026 18:39
9e4753e to
bbc4fcc
Compare
thebrandonlucas
force-pushed
the
docs/cli-guides
branch
from
October 19, 2026 18:47
bbc4fcc to
a8e9156
Compare
thebrandonlucas
force-pushed
the
docs/cli-guides
branch
2 times, most recently
from
October 19, 2026 19:19
a51c322 to
7d944c2
Compare
This was referenced Oct 19, 2026
New guides cover wallets (create, inspect, ledger, policies, delete) and webhooks (create with a saved secret, events, test, pause, rotation, deliveries). The docs index links both. An integration test now runs every change the docs show with --execute as an offline --dry-run --json and requires exit 0 and outcome dry_run, with no request reaching the mock API. It caught that webhooks test needs a --data body. The docs example extractor moves to tests/support/examples.rs so the parse test and the dry-run test share it.
thebrandonlucas
force-pushed
the
docs/cli-guides
branch
from
October 20, 2026 00:20
7d944c2 to
14e95fc
Compare
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
1 participant
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.
Stack: master ← #20 ← #22 ← #24 ← #19 ← this PR. Plan 07, phase 3 (guides). Docs-only apart from tests.
docs/guides/wallets.md(create, inspect, ledger, policies, delete) anddocs/guides/webhooks.md(create with--output-filefor the one-time secret, event names from the contract, test, stop/start, key rotation, deliveries). The docs index links both.--execute, swaps in--dry-run --json, and requires exit 0 andoutcome: dry_run, with no request reaching the mock API and no--output-filecreated. Placeholder IDs become a fixed UUID. Examples that read a--datafile are skipped; request body tests cover those.tests/support/examples.rsholds the docs example extractor, included by the existing parse test insrc/cli.rsand by the new integration test.The new test found a real docs bug while writing these guides:
webhooks testneeds a--databody (delivery_idandpayload), so the guide shows it that way.Payments, receive/send, prices, checkout, and payment reliability are already covered by
payments.md,checkout.md, and the safety model, so this PR does not split or duplicate them.Validation:
cargo fmt --check,cargo clippy --locked --all-targets -- -D warnings,cargo machete --with-metadata,cargo test --locked(94 unit, 69 integration), andpython3 scripts/check-coverage.py.