Start Here
Documentation for Users
-
README: Project overview and installation
Getting Started
-
Why RatatuiRuby?: Philosophy, comparisons, and what makes us different
-
Quickstart: Build your first TUI app
Concepts
-
Application Architecture: Lifecycle patterns and API choices
-
Event Handling: Keyboard, mouse, and terminal events
-
Interactive Design: Cached layout pattern for hit testing
-
Testing Your Application: Snapshot testing and style assertions
-
Custom Widgets: Build anything with the Draw API
-
Async Operations: Background tasks and non-blocking I/O
Troubleshooting
-
Debugging: Debugging techniques and tools
-
Terminal Limitations: Platform quirks and workarounds
Documentation for Contributors
-
Contributing Guidelines: How to contribute patches and features
-
More Documentation for Contributors: Internal design docs and style guides