docs: Add comprehensive TUI module documentation#83
Merged
Conversation
Add detailed architecture documentation and user-facing guides for the Terminal User Interface (TUI) module implemented in issue #68. Changes: - ARCHITECTURE.md: Add extensive TUI architecture section covering: - Module structure and component descriptions - ViewMode state machine and event handling - RollingBuffer design for memory protection - Event loop architecture and state management - Performance characteristics and optimization strategies - Error handling and terminal safety with RAII guards - README.md: Enhance TUI documentation with: - Comprehensive keyboard shortcuts reference table - View modes description table - TUI activation conditions and requirements - Feature highlights (progress detection, memory limits) - src/ui/tui/app.rs: Add missing keyboard shortcut to help overlay - Add "1-9: Jump to node N" in detail view help text Resolves #81 Related to #68
- Remove line counts from ARCHITECTURE.md to prevent documentation drift - Add footnote for unimplemented diff view scroll feature in README.md
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
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.
Summary
This PR adds comprehensive documentation for the Terminal User Interface (TUI) module that was implemented in issue #68. The documentation covers both the technical architecture (for developers) and user-facing features (for end users).
Documentation Updates
ARCHITECTURE.md
Added extensive TUI architecture section (~500 lines) covering:
README.md
Enhanced TUI documentation with user-friendly reference:
src/ui/tui/app.rs
Fixed missing keyboard shortcut in help overlay:
Related Issues
Test Plan
event.rsChecklist