镜像站点 · 本页由第三方 GitHub 只读镜像提供,非 GitHub 官方站点,不接受任何登录或凭据输入。前往 github.com
Skip to content

docs: add global flag, environment, and configuration references - #28

Merged
thebrandonlucas merged 1 commit into
feat/cli-help-examplesfrom
docs/cli-reference
Oct 20, 2026
Merged

thebrandonlucas merged 1 commit into
feat/cli-help-examplesfrom
docs/cli-reference

Conversation

@thebrandonlucas

@thebrandonlucas thebrandonlucas commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Stack: master ← #26 ← #27 ← #28 ← #29 ← #30 ← #55 ← #60. #20, #22, #57, #24 and #19 are merged.

Page Source Kept true by
docs/reference/global-flags.md Rendered from GlobalFlags A golden test; VOLTAGE_BLESS=1 cargo test regenerates it
docs/reference/environment.md Hand-written: every VOLTAGE_* variable, XDG_CONFIG_HOME, COLUMNS, and the flag that beats each A test that every VOLTAGE_* literal in src/ and its subdirectories is listed
docs/reference/configuration.md Hand-written: the configuration directory, config.toml, credential stores, the lock, the request journal The relative-link and anchor check
docs/reference/exit-codes.md Existing A test that every ErrorKind code is listed; an exhaustive match makes a new kind fail to compile until it is added

The docs index links the new pages, and the development guide explains VOLTAGE_BLESS.

Not in this PR: a help-rendered command reference. Rendering --help for all 60 commands would exceed the 1,000-line limit on its own; --help now carries examples and a guide link (#27), and docs/commands.md keeps the generated route table.

Changes after review

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 --locked leaves the tree clean.
  • python3 scripts/check-coverage.py: pass.
  • CRAP (scripts/crap-report.sh): no function at or above 20. Highest is api::wait_for_payment at 19.24, unchanged from or lower than master (19.66).
  • Skill review: voltage-pr-review and the voltage-backend-engineering Rust checklist, against the stack base. Findings are fixed in this commit.

Not run: the staging and live tutorials, which need credentials.

@thebrandonlucas
thebrandonlucas added this pull request to stack #25 October 13, 2026 19:06
@thebrandonlucas
thebrandonlucas force-pushed the docs/cli-reference branch 2 times, most recently from 5b4059b to 00d92ee Compare October 19, 2026 13:14
@thebrandonlucas
thebrandonlucas force-pushed the docs/cli-reference branch 2 times, most recently from d1cb04b to 189ff05 Compare October 19, 2026 18:39
@thebrandonlucas
thebrandonlucas force-pushed the docs/cli-reference branch 2 times, most recently from 623707c to e34b7c8 Compare October 19, 2026 19:19
@thebrandonlucas
thebrandonlucas force-pushed the docs/cli-reference branch 2 times, most recently from 4db8871 to ac11d1e Compare October 20, 2026 11:58
@thebrandonlucas
thebrandonlucas removed this pull request from stack #25 October 20, 2026 11:59

@tee8z tee8z left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/reference/environment.md Resolved
Comment thread docs/reference/environment.md Resolved
Comment thread docs/reference/configuration.md Resolved
@thebrandonlucas
thebrandonlucas force-pushed the docs/cli-reference branch 2 times, most recently from 2fe8856 to e1436ed Compare October 20, 2026 16:36
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.
@tee8z
tee8z self-requested a review October 20, 2026 16:51
@thebrandonlucas
thebrandonlucas merged commit 1960f4a into master Oct 20, 2026
6 checks passed
@thebrandonlucas
thebrandonlucas deleted the docs/cli-reference branch October 20, 2026 17:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

human review wanted CI passes; ready for a human reviewer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants