Repository navigation
docs: add wallet and webhook guides and dry-run every documented change - #26
Merged
Merged
Conversation
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
thebrandonlucas
force-pushed
the
docs/cli-guides
branch
2 times, most recently
from
October 20, 2026 11:58
14e95fc to
fa99a04
Compare
thebrandonlucas
force-pushed
the
docs/cli-guides
branch
from
October 20, 2026 12:25
fa99a04 to
c22b3f0
Compare
thebrandonlucas
force-pushed
the
docs/cli-guides
branch
from
October 20, 2026 13:01
c22b3f0 to
d1482ef
Compare
tee8z
self-requested a review
October 20, 2026 14:24
tee8z
reviewed
Oct 20, 2026
tee8z
self-requested a review
October 20, 2026 14:30
tee8z
previously approved these changes
Oct 20, 2026
tee8z
left a comment
Contributor
There was a problem hiding this comment.
nothing blocking, just one suggestion, this is ready to go otherwise
tee8z
reviewed
Oct 20, 2026
tee8z
left a comment
Contributor
There was a problem hiding this comment.
A few small doc notes, none blocking. The robot checked the guides against the code and the contract: the event table, the wallets create flags, ndjson, and the one-time-secret refusal all match. CRAP on d1482ef: no function at or above 20, highest api::wait_for_payment at 19.24. All 98 unit and 86 integration tests pass.
thebrandonlucas
dismissed
tee8z’s stale review
October 20, 2026 15:17
The merge-base changed after approval.
thebrandonlucas
force-pushed
the
docs/cli-guides
branch
from
October 20, 2026 15:17
d1482ef to
ed52065
Compare
thebrandonlucas
force-pushed
the
docs/cli-guides
branch
from
October 20, 2026 15:32
ed52065 to
80f327d
Compare
tee8z
self-requested a review
October 20, 2026 15:44
tee8z
previously approved these changes
Oct 20, 2026
tee8z
left a comment
Contributor
There was a problem hiding this comment.
nothing blocking, just some suggestions/optional changes
thebrandonlucas
dismissed
tee8z’s stale review
October 20, 2026 16:12
The merge-base changed after approval.
thebrandonlucas
force-pushed
the
docs/cli-guides
branch
from
October 20, 2026 16:12
80f327d to
99d4c96
Compare
tee8z
self-requested a review
October 20, 2026 16:12
tee8z
previously approved these changes
Oct 20, 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 16:36
99d4c96 to
4cfa07d
Compare
tee8z
self-requested a review
October 20, 2026 16:48
tee8z
approved these changes
Oct 20, 2026
3 of 5 tasks
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.
Stack: master ← #26 ← #27 ← #28 ← #29 ← #30 ← #55 ← #60. #20, #22, #57, #24 and #19 are merged.
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. Placeholder IDs become a fixed UUID. Examples that read a--datafile get stub bodies (payment.json,policies.json,test-delivery.json), and--data -gets the payment body on stdin. A new@FILEin the docs fails the test until it has a stub.--output-file, journal, or other file appears.tests/support/examples.rsholds the docs example extractor, included by the 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.--dry-runin this layer: #30 removes--dry-runfurther up the stack and rewrites these lines and this test to run without--executeinstead. This layer is accurate for its own head.Changes after review
--dataexamples run too, with stub bodies, so the development guide's claim that every documented change runs offline is now true. The minimum number of checked examples rose from 15 to 19.webhook.json.Checks
On
4cfa07d:cargo fmt --check,cargo clippy --locked --all-targets -- -D warnings,cargo machete --with-metadata: pass.cargo test --locked: 98 unit and 86 integration tests pass.VOLTAGE_BLESS=1 cargo test --lockedleaves the tree clean.python3 scripts/check-coverage.py: pass.scripts/crap-report.sh): no function at or above 20. Highest isapi::wait_for_paymentat 19.24, unchanged from or lower than master (19.66).voltage-pr-reviewand thevoltage-backend-engineeringRust checklist, against the stack base. Findings are fixed in this commit.Not run: the staging and live tutorials, which need credentials.