Repository navigation
docs: add global flag, environment, and configuration references - #28
Merged
Merged
Conversation
This was referenced Oct 13, 2026
thebrandonlucas
force-pushed
the
docs/cli-reference
branch
2 times, most recently
from
October 19, 2026 13:14
5b4059b to
00d92ee
Compare
thebrandonlucas
force-pushed
the
docs/cli-reference
branch
from
October 19, 2026 13:15
00d92ee to
7513e6d
Compare
thebrandonlucas
force-pushed
the
docs/cli-reference
branch
from
October 19, 2026 13:47
7513e6d to
ce29ccc
Compare
thebrandonlucas
force-pushed
the
docs/cli-reference
branch
2 times, most recently
from
October 19, 2026 18:39
d1cb04b to
189ff05
Compare
thebrandonlucas
force-pushed
the
docs/cli-reference
branch
from
October 19, 2026 18:47
189ff05 to
c85a0c9
Compare
thebrandonlucas
force-pushed
the
docs/cli-reference
branch
2 times, most recently
from
October 19, 2026 19:19
623707c to
e34b7c8
Compare
This was referenced Oct 19, 2026
thebrandonlucas
force-pushed
the
docs/cli-reference
branch
2 times, most recently
from
October 20, 2026 11:58
4db8871 to
ac11d1e
Compare
This was referenced Oct 20, 2026
thebrandonlucas
force-pushed
the
docs/cli-reference
branch
from
October 20, 2026 12:25
ac11d1e to
64ffa2e
Compare
tee8z
self-requested a review
October 20, 2026 12:33
thebrandonlucas
force-pushed
the
docs/cli-reference
branch
from
October 20, 2026 13:01
64ffa2e to
a29a244
Compare
thebrandonlucas
force-pushed
the
docs/cli-reference
branch
from
October 20, 2026 15:17
a29a244 to
1c56ab5
Compare
thebrandonlucas
force-pushed
the
docs/cli-reference
branch
from
October 20, 2026 15:32
1c56ab5 to
0a93ed7
Compare
tee8z
requested changes
Oct 20, 2026
tee8z
left a comment
Contributor
There was a problem hiding this comment.
One sentence in environment.md describes the precedence wrongly; the rest checked out against the code (config directory order and checks, files, VOLTAGE_EXECUTE values, every variable the code reads). The other two comments are optional. CRAP on 0a93ed7: no function at or above 20, highest api::wait_for_payment at 19.24; the full test suite passed in the same run.
thebrandonlucas
force-pushed
the
docs/cli-reference
branch
2 times, most recently
from
October 20, 2026 16:36
2fe8856 to
e1436ed
Compare
docs/reference/global-flags.md is rendered from GlobalFlags by a test: plain cargo test fails when it is stale, and VOLTAGE_BLESS=1 cargo test rewrites it. New hand-written pages cover every environment variable with the flag that beats it, and the configuration directory, credential stores, and request journal. Parity tests require every VOLTAGE_* variable read in src/ to appear in the environment reference, and every exit code in the exit code reference; the exit code list is checked by an exhaustive match, so a new ErrorKind fails to compile until it is listed.
thebrandonlucas
force-pushed
the
docs/cli-reference
branch
from
October 20, 2026 16:51
e1436ed to
0756d32
Compare
tee8z
self-requested a review
October 20, 2026 16:51
tee8z
approved these changes
Oct 20, 2026
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/reference/global-flags.mdGlobalFlagsVOLTAGE_BLESS=1 cargo testregenerates itdocs/reference/environment.mdVOLTAGE_*variable,XDG_CONFIG_HOME,COLUMNS, and the flag that beats eachVOLTAGE_*literal insrc/and its subdirectories is listeddocs/reference/configuration.mdconfig.toml, credential stores, the lock, the request journaldocs/reference/exit-codes.mdErrorKindcode is listed; an exhaustivematchmakes a new kind fail to compile until it is addedThe docs index links the new pages, and the development guide explains
VOLTAGE_BLESS.Not in this PR: a help-rendered command reference. Rendering
--helpfor all 60 commands would exceed the 1,000-line limit on its own;--helpnow carries examples and a guide link (#27), anddocs/commands.mdkeeps the generated route table.Changes after review
--config-dirdocuments its real default:VOLTAGE_CONFIG_DIR, else$XDG_CONFIG_HOME/voltage, else~/.config/voltage. Before,global-flags.mdsaid only~/.config/voltage, which contradictedconfiguration.md.src/recursively (rust_sources), with a test that it reachessrc/output/human.rs.VOLTAGE_DOCS_REF(feat(cli): show examples and a guide link in every command's help #27, a build-time value) is excluded.ErrorKindis imported at module scope, and the exhaustive list is anerror_kinds()helper that docs: add troubleshooting, getting started, a changelog, its CI check, and a PR template #29 reuses.--executeis per command, not global, and links the safety model.Checks
On
e1436ed:cargo fmt --check,cargo clippy --locked --all-targets -- -D warnings,cargo machete --with-metadata: pass.cargo test --locked: 102 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.