Repository navigation
docs: add global flag, environment, and configuration references - #28
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:06
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
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 00:20
e34b7c8 to
4db8871
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 ← #26 ← #27 ← this PR. Plan 07, phase 4 (reference).
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/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.Validation:
cargo fmt --check,cargo clippy --locked --all-targets -- -D warnings,cargo machete --with-metadata,cargo test --locked(97 unit, 69 integration), andpython3 scripts/check-coverage.py.