Skip to content

docs: add comprehensive TUI dashboard guide#203

Merged
jdx merged 1 commit into
mainfrom
feat/tui-docs
Jan 19, 2026
Merged

docs: add comprehensive TUI dashboard guide#203
jdx merged 1 commit into
mainfrom
feat/tui-docs

Conversation

@jdx

@jdx jdx commented Jan 19, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add comprehensive documentation for the interactive TUI dashboard feature
  • Document all keyboard shortcuts in a reference table
  • Explain features: search filtering, profile switching, copy to clipboard, edit secrets
  • Add tips for common workflows

Test plan

  • Verify docs build locally with mise run docs:dev
  • Check all links work in sidebar navigation
  • Confirm keyboard shortcuts match actual TUI behavior

🤖 Generated with Claude Code


Note

Introduces documentation for the interactive terminal UI and surfaces it in navigation.

  • Adds docs/guide/tui.md detailing features (secret list, search, profile switching, details, copy, edit), keyboard shortcuts reference, mouse support, and tips
  • Updates docs/.vitepress/config.mjs to include "TUI Dashboard" under the Features sidebar

Written by Cursor Bugbot for commit 5f818bd. This will update automatically on new commits. Configure here.

Add documentation for the interactive TUI dashboard feature including:
- Keyboard shortcuts reference table
- Mouse support documentation
- Feature explanations (search, profile switching, copy, edit)
- Tips for common workflows

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings January 19, 2026 18:10

Copilot AI 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.

Pull request overview

This PR adds comprehensive documentation for fnox's interactive TUI dashboard feature, enabling users to browse and manage secrets through a terminal interface.

Changes:

  • Added detailed TUI documentation covering features, keyboard shortcuts, and common workflows
  • Integrated TUI docs into the sidebar navigation under Features section

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/guide/tui.md New comprehensive guide documenting TUI dashboard features, keyboard shortcuts, mouse support, and usage tips
docs/.vitepress/config.mjs Added TUI Dashboard link to Features section in sidebar navigation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jdx jdx merged commit 35f55b7 into main Jan 19, 2026
19 checks passed
@jdx jdx deleted the feat/tui-docs branch January 19, 2026 18:41
jdx pushed a commit that referenced this pull request Jan 25, 2026
### 🚀 Features

- **(1password)** add token field supporting secret references by
[@jdx](https://github.com/jdx) in
[#200](#200)
- **(vault)** add namespace option by
[@pierrop](https://github.com/pierrop) in
[#220](#220)
- add JSON schema for fnox.toml by [@jdx](https://github.com/jdx) in
[#196](#196)
- add --all flag to provider test command by
[@jdx](https://github.com/jdx) in
[#202](#202)
- add documentation URLs to error diagnostics by
[@jdx](https://github.com/jdx) in
[#212](#212)
- preserve source error chains for JSON/YAML errors by
[@jdx](https://github.com/jdx) in
[#214](#214)
- use structured error variants instead of generic Config/Provider by
[@jdx](https://github.com/jdx) in
[#213](#213)
- add "Did you mean?" suggestions for typos by
[@jdx](https://github.com/jdx) in
[#204](#204)
- add --dry-run flag to data-modifying commands by
[@jdx](https://github.com/jdx) in
[#201](#201)
- Support fnox.toml (and variants) dotfiles. by
[@dharrigan](https://github.com/dharrigan) in
[#141](#141)
- add source code spans for better error reporting by
[@jdx](https://github.com/jdx) in
[#205](#205)
- use #[related] for validation errors to show all issues at once by
[@jdx](https://github.com/jdx) in
[#211](#211)
- add source code span tracking for default_provider errors by
[@jdx](https://github.com/jdx) in
[#209](#209)
- add source code span tracking for SecretConfig.value by
[@jdx](https://github.com/jdx) in
[#210](#210)
- improve miette error handling with structured provider errors and URLs
by [@jdx](https://github.com/jdx) in
[#216](#216)

### 🐛 Bug Fixes

- update claude CLI model and add bypassPermissions by
[@jdx](https://github.com/jdx) in
[#194](#194)
- update claude CLI model and add bypassPermissions by
[@jdx](https://github.com/jdx) in
[#195](#195)
- preserve TOML comments in `fnox set` by [@jdx](https://github.com/jdx)
in [#223](#223)

### 🚜 Refactor

- convert miette::miette!() to FnoxError in encrypt.rs and list.rs by
[@jdx](https://github.com/jdx) in
[#208](#208)
- use structured errors in remove and export commands by
[@jdx](https://github.com/jdx) in
[#206](#206)
- use structured errors in import command by
[@jdx](https://github.com/jdx) in
[#207](#207)

### 📚 Documentation

- add comprehensive TUI dashboard guide by
[@jdx](https://github.com/jdx) in
[#203](#203)
- add mise integration guide by [@jdx](https://github.com/jdx) in
[#215](#215)

### ⚡ Performance

- reduce KMS API calls in CI tests by [@jdx](https://github.com/jdx) in
[#217](#217)

### 🛡️ Security

- add Black Ops One font branding to docs by
[@jdx](https://github.com/jdx) in
[#198](#198)

### 📦️ Dependency Updates

- lock file maintenance by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#197](#197)
- update jdx/mise-action digest to 6d1e696 by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#218](#218)
- update rust crate proc-macro2 to v1.0.106 by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#219](#219)

### New Contributors

- @pierrop made their first contribution in
[#220](#220)
- @dharrigan made their first contribution in
[#141](#141)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants