docs: Fix TUI documentation issues and update CAI-Pro links #328
Conversation
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
- Create docs/tui/ directory structure - Add comprehensive TUI overview and index page - Document TUI features: multi-terminal support, teams, parallel execution - Add comparison table: TUI vs CLI use cases - Include system requirements and supported terminals - Document keyboard shortcuts and commands reference - Add architecture overview and component structure - Include quick start guide and documentation navigation
- Add cai-tui-main.png screenshot to docs/media/ - Screenshot shows TUI interface for documentation
- Add comprehensive getting-started.md for TUI - Cover all 9 steps from launch to monitoring costs - Include prerequisites and system requirements - Document API key configuration process - Explain model and agent selection - Provide practical examples for first conversations - Document multi-terminal workflows - Explain team configurations - Add troubleshooting section for common issues - Include next steps and learning paths
- Replace private IP 192.168.1.1 with documentation IP 198.51.100.50 (RFC 5737) - Add GPT-5 model to available models table - Add Claude 4-5 model to available models table - Update model descriptions for clarity - Ensure example IPs are safe for public documentation
- Rename docs/tui/getting-started.md to getting_started.md (underscore format) - Update all references in tui_index.md (3 occurrences) - Maintain consistency with other markdown files naming convention
- Remove alternative launch methods for cleaner first steps - Remove 'Launch with Initial Prompt' section - Remove 'Launch with YAML Configuration' section - Focus on basic launch command for new users
- Replace broken documentation links with 🚧 indicators - Add explanatory notes about documentation in development - Convert inline links to plain text references - Keep existing links (getting_started.md, cai_installation.md, cai_architecture.md) - Maintain documentation structure for future expansion
…ayout screenshots, and reorganized command palette
…cuts, user_interface)
…rgeting methods, and UI refinements
…info, and automatic queue behavior
…config guide, update model references, remove deprecated content
… command references
…onfig/faq references
Resolved conflicts by keeping updated TUI documentation: - docs/tui/getting_started.md: Updated installation guide link - docs/tui/tui_index.md: Active links to all TUI documentation files Merged upstream changes from other contributors: - PR aliasrobotics#311: Extended CAIBench documentation with new benchmark page - PR aliasrobotics#317: Fixed OSX installation documentation - Added cai_benchmark.md to mkdocs.yml navigation - Updated benchmarks README and evaluation scripts - Added benchmark visualization images
- Fix getting_started.md: remove 'coming soon' flags and activate all doc links - Fix terminals_management.md: replace broken links with existing documentation - Fix troubleshooting.md: remove non-existent configuration.md link - Update all CAI-Pro banner links to point to cybersecurityai.php page
- Resolved conflicts in TUI documentation files - Kept updated CAI-Pro banner links (cybersecurityai.php) - Integrated new /ctx command documentation from upstream - Synced with benchmarking docs and other upstream improvements
vmayoral
approved these changes
Nov 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 fixes some issues found in the TUI documentation and updates all CAI-Pro banner links to point to the correct product page.
Changes
Fixed Issues
configuration.mdUpdated Links
https://aliasrobotics.comtohttps://aliasrobotics.com/cybersecurityai.php(10 files)Integrated Upstream Changes
/ctxcommand documentationFiles Modified
commands_reference.mdnow includes the new/context(/ctx) command from upstream