Document menus, presets and theme installation #30

Closed
opened 2026-11-16 14:39:29 +00:00 by aaron · 1 comment
Owner

Story

As a TrueNAS user, I want to learn the controls and customization options so that monitoring fits my workflow.

Context

Parent scope: #7.

Document the actual TrueNAS adaptation. Each feature issue owns its tests; this issue owns user-facing docs.

Upstream: btop 5d03929a.

Acceptance criteria

  • Document all keyboard/mouse actions, menu categories and modal input rules.
  • Provide valid default/custom preset examples, --preset usage and proc-to-apps mapping.
  • Explain bundled/user themes, name precedence, explicit paths, background behavior and low-color/TTY modes.
  • Explain why installer #4 and self-update #6 need no separate theme-folder copy.
  • List unsupported upstream settings and preserve truthful descriptions of aggregate I/O and estimated network totals.
  • Check examples against actual CLI/config behavior and run Markdown/editorconfig checks.

Dependencies

Blocked by #11, #12, #16, #17, #21, #22, #23, #24, #25, #26, #27, #28, #29.

## Story As a TrueNAS user, I want to learn the controls and customization options so that monitoring fits my workflow. ## Context Parent scope: #7. Document the actual TrueNAS adaptation. Each feature issue owns its tests; this issue owns user-facing docs. Upstream: [btop 5d03929a](https://github.com/aristocratos/btop/tree/5d03929a45e0720a4c8e2d189360ff1eb9ce1731). ## Acceptance criteria - [x] Document all keyboard/mouse actions, menu categories and modal input rules. - [x] Provide valid default/custom preset examples, --preset usage and proc-to-apps mapping. - [x] Explain bundled/user themes, name precedence, explicit paths, background behavior and low-color/TTY modes. - [x] Explain why installer #4 and self-update #6 need no separate theme-folder copy. - [x] List unsupported upstream settings and preserve truthful descriptions of aggregate I/O and estimated network totals. - [x] Check examples against actual CLI/config behavior and run Markdown/editorconfig checks. ## Dependencies Blocked by #11, #12, #16, #17, #21, #22, #23, #24, #25, #26, #27, #28, #29.
aaron added this to the v0.2.0 milestone 2026-11-16 14:41:42 +00:00
Author
Owner

Verified against pushed main at 1a17d5f520. Completing commit: 1a17d5f520.

Checked README controls, menu categories, modal rules, theme precedence/background/TTY modes, default/custom presets, proc alias, updater/install behavior and unsupported scope against the implementation. Earlier CLI checks validated the documented preset examples. Markdown and EditorConfig checks pass again.

Fresh checks: all 103 Rust/CLI tests, all lint tasks, all-target/all-feature compilation, build, and all 3 Unix installer tests passed on macOS. The owner approved the live UI and panel-border controls. Final cross-platform packaged-binary checks remain in #7.

Closing after verification; the push stopped automatic issue processing at the dependency on #10.

Verified against pushed main at 1a17d5f520b4aee3f38250931223df054858f6fb. Completing commit: 1a17d5f520b4aee3f38250931223df054858f6fb. Checked README controls, menu categories, modal rules, theme precedence/background/TTY modes, default/custom presets, proc alias, updater/install behavior and unsupported scope against the implementation. Earlier CLI checks validated the documented preset examples. Markdown and EditorConfig checks pass again. Fresh checks: all 103 Rust/CLI tests, all lint tasks, all-target/all-feature compilation, build, and all 3 Unix installer tests passed on macOS. The owner approved the live UI and panel-border controls. Final cross-platform packaged-binary checks remain in #7. Closing after verification; the push stopped automatic issue processing at the dependency on #10.
aaron closed this issue 2026-11-16 17:30:05 +00:00
Sign in to join this conversation.
No milestone
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference
aaron/tntop#30
No description provided.