mirror of https://github.com/aliasrobotics/cai.git
docs: Fix TUI documentation issues and update CAI-Pro links (#328)
* docs: add TUI documentation index page
- 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
* docs: add TUI main interface screenshot
- Add cai-tui-main.png screenshot to docs/media/
- Screenshot shows TUI interface for documentation
* docs: add TUI getting started guide
- 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
* docs: improve security and update model information in getting-started
- 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
* docs: minimum change
* docs: rename getting-started.md to getting_started.md for consistency
- 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
* docs: simplify TUI launch section in getting_started
- 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
* docs: prepare TUI docs for PR by managing broken links
- 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
* docs: add CAI-Pro exclusive banner to TUI documentation
* docs: add comprehensive TUI user interface documentation
* docs: improve TUI user-interface with enhanced topbar descriptions, layout screenshots, and reorganized command palette
* Minimal changes
* docs: update user-interface content
* docs: add comprehensive keyboard shortcuts reference for TUI
* Restructure
* docs: rename files to use underscores for consistency (keyboard_shortcuts, user_interface)
* docs: add comprehensive commands reference for TUI
* docs: update commands_reference with enhanced agent list, terminal targeting methods, and UI refinements
* docs: activate links for completed TUI documentation files
* docs: add terminals_management.md with multi-terminal workflows and layouts
* docs: add remaining layout images and refine terminals_management content
* docs: add CAI-5+terminals.png screenshot to media folder
* docs: fix formatting issue in terminals_management removing terminals section
* docs: add terminal anatomy screenshot to terminals_management
* docs: fix triple terminal layout description to accurately reflect three-column split
* docs: minimal fix
* docs: add sidebar_features.md with Teams, Queue, Stats, and Keys tabs documentation
* docs: update sidebar_features with correct team compositions, ALIAS1 info, and automatic queue behavior
* docs: fix code block formatting in sidebar_features ALIAS1 section
* docs: add teams_and_parallel_execution.md with coordination patterns and strategies
* docs: update model references to use alias models in teams_and_parallel_execution
* docs: add advanced_features.md with ICL, MCP, guardrails, and integration guides
* docs: refactor advanced_features - simplify MCP section with link to config guide, update model references, remove deprecated content
* docs: fix MCP configuration guide link path in advanced_features
* docs: standardize env vars and add guardrails documentation link in advanced_features
* docs: remove auto-save reference and help message in advanced_features
* docs: add troubleshooting guide for TUI
* docs: refine troubleshooting - remove install/launch sections, update command references
* docs: finalize tui_index - activate all doc links, remove flags and config/faq references
* docs: update installation guide link to new v0.6 documentation
* docs: remove broken link and fix formatting in TUI docs
* docs: fix TUI documentation issues and update CAI-Pro links
- 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
This commit is contained in:
danielsanchezprieto01
GitHub
parent
3667db1083
commit
e75d7a97fc
|
|
@ -1,7 +1,7 @@
|
|||
# Advanced Features
|
||||
|
||||
> **⚡ CAI-Pro Exclusive Feature**
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com) for more information.
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com/cybersecurityai.php) for more information.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# CAI TUI Commands Reference
|
||||
|
||||
> **⚡ CAI-Pro Exclusive Feature**
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com) for more information.
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com/cybersecurityai.php) for more information.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Getting Started with CAI TUI
|
||||
|
||||
> **⚡ CAI-Pro Exclusive Feature**
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com) for more information.
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com/cybersecurityai.php) for more information.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -324,22 +324,15 @@ Open the sidebar (`Ctrl+S`) and go to **"Stats"** tab to see:
|
|||
|
||||
Congratulations! You've completed the basics of CAI TUI. Here's what to explore next:
|
||||
|
||||
> **Note**: Additional TUI documentation is currently being developed. Topics marked with 🚧 will be available soon.
|
||||
|
||||
### Learn More Commands
|
||||
- 📖 Commands Reference 🚧 - Master all available commands
|
||||
- ⌨️ Keyboard Shortcuts 🚧 - Speed up your workflow
|
||||
- 📖 [Commands Reference](commands_reference.md) - Master all available commands
|
||||
- ⌨️ [Keyboard Shortcuts](keyboard_shortcuts.md) - Speed up your workflow
|
||||
|
||||
### Explore Advanced Features
|
||||
- 👥 Teams and Parallel Execution 🚧 - Multi-agent workflows
|
||||
- 🔧 MCP Integration 🚧 - Connect external tools
|
||||
- 💾 Session Management 🚧 - Advanced save/load
|
||||
|
||||
### Customize Your Setup
|
||||
- ⚙️ Configuration 🚧 - Environment variables and settings
|
||||
- 👥 [Teams and Parallel Execution](teams_and_parallel_execution.md) - Multi-agent workflows
|
||||
- 🚀 [Advanced Features](advanced_features.md) - MCP, ICL, and more
|
||||
|
||||
### Get Help
|
||||
- ❓ FAQ 🚧 - Common questions
|
||||
- 🔧 Troubleshooting 🚧 - Solve issues
|
||||
- 🔧 [Troubleshooting](troubleshooting.md) - Solve issues
|
||||
- 💬 [Community Discord](https://discord.gg/aliasrobotics) - Ask questions
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# CAI TUI Keyboard Shortcuts
|
||||
|
||||
> **⚡ CAI-Pro Exclusive Feature**
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com) for more information.
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com/cybersecurityai.php) for more information.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Sidebar Features
|
||||
|
||||
> **⚡ CAI-Pro Exclusive Feature**
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com) for more information.
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com/cybersecurityai.php) for more information.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Teams and Parallel Execution
|
||||
|
||||
> **⚡ CAI-Pro Exclusive Feature**
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com) for more information.
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com/cybersecurityai.php) for more information.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# CAI TUI Terminals Management
|
||||
|
||||
> **⚡ CAI-Pro Exclusive Feature**
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com) for more information.
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com/cybersecurityai.php) for more information.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -676,8 +676,8 @@ Each terminal is independent - use this for:
|
|||
|
||||
- [Commands Reference](commands_reference.md) - Complete command documentation
|
||||
- [Keyboard Shortcuts](keyboard_shortcuts.md) - All keyboard shortcuts
|
||||
- [Teams Configuration](teams_preconfigured.md) - Deep dive into teams
|
||||
- [Session Management](session_management.md) - Save, load, and export sessions
|
||||
- [Sidebar Features](sidebar_features.md) - Teams tab and other sidebar capabilities
|
||||
- [Advanced Features](advanced_features.md) - MCP, ICL, and session management
|
||||
|
||||
For questions or issues, visit [CAI GitHub Issues](https://github.com/aliasrobotics/cai/issues).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Troubleshooting
|
||||
|
||||
> **⚡ CAI-Pro Exclusive Feature**
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com) for more information.
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com/cybersecurityai.php) for more information.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -160,9 +160,9 @@ If your issue isn't covered here:
|
|||
## Related Documentation
|
||||
|
||||
- [Getting Started](getting_started.md) - Setup and configuration
|
||||
- [Configuration](configuration.md) - Environment variables and settings
|
||||
- [Commands Reference](commands_reference.md) - All available commands
|
||||
- [User Interface](user_interface.md) - UI components explained
|
||||
- [Advanced Features](advanced_features.md) - Environment variables and settings
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# CAI Terminal User Interface (TUI)
|
||||
|
||||
> **⚡ CAI-Pro Exclusive Feature**
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com) for more information.
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com/cybersecurityai.php) for more information.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# CAI TUI User Interface
|
||||
|
||||
> **⚡ CAI-Pro Exclusive Feature**
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com) for more information.
|
||||
> The Terminal User Interface (TUI) is available exclusively in **CAI-Pro**. To access this feature and unlock advanced multi-agent workflows, visit [Alias Robotics](https://aliasrobotics.com/cybersecurityai.php) for more information.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue