Skip to content

docs: document Energy Session config in TUI help, --help, and manpage#209

Merged
inureyes merged 1 commit into
mainfrom
docs/energy-session-help
Apr 30, 2026
Merged

docs: document Energy Session config in TUI help, --help, and manpage#209
inureyes merged 1 commit into
mainfrom
docs/energy-session-help

Conversation

@inureyes

Copy link
Copy Markdown
Member

Summary

Document the Energy Session feature (kWh accumulation + $/kWh cost
estimate, added in #201) across all three help surfaces so users can
discover and configure it without reading source.

Changes

  • TUI help (`h` key) — `src/ui/help.rs`: new "Energy Session" subsection in the right column explaining what the panel shows, the `R` reset shortcut, and the price/currency/no-cost env overrides.
  • `all-smi --help` — `src/cli.rs`: added `after_help` text on the top-level `Cli` listing the `[energy]` TOML section and all six `ALL_SMI_ENERGY_*` environment variables.
  • manpage — `docs/man/all-smi.1`: new `ENERGY ACCOUNTING` section documenting the integrator semantics (kWh from time-integrated power, monotonic Prometheus counter vs. resettable session counter) and every supported override.

Test plan

  • `cargo build --release` succeeds (the 7 "unused import" warnings are unrelated; fix in flight as fix: remove unused imports in doctor checks modules #208).
  • `./target/release/all-smi --help` shows the new "Energy Session" trailer.
  • `mandoc -T ascii docs/man/all-smi.1` renders the new section without errors.
  • Visually inspect the `h` overlay in a TUI session.

Adds an Energy Session subsection to the in-app h-key overlay
explaining what kWh / cost / avg-power figures are derived from and
how to configure them, plus a matching after_help block on the top-
level CLI and a new ENERGY ACCOUNTING section in the manpage covering
[energy] TOML keys and ALL_SMI_ENERGY_* environment overrides.
@inureyes inureyes added type:docs Improvements or additions to documentation priority:medium Medium priority issue status:review Under review labels Apr 30, 2026
@inureyes inureyes merged commit b791c79 into main Apr 30, 2026
4 checks passed
@inureyes inureyes deleted the docs/energy-session-help branch April 30, 2026 20:00
@inureyes inureyes self-assigned this May 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority:medium Medium priority issue status:review Under review type:docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant