cai/docs
danielsanchezprieto01 f00779186e
Docs/Adds comprehensive documentation for the CAI Terminal User Interface (TUI), covering all aspects from basic usage to advanced features. (#320)
* 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
2025-10-31 12:55:12 +01:00
..
assets Extended CAIBench README (#311) 2025-10-28 14:38:07 +01:00
cai Added missing step in OSX install documentation. (#317) 2025-10-29 14:44:59 +01:00
media Docs/Adds comprehensive documentation for the CAI Terminal User Interface (TUI), covering all aspects from basic usage to advanced features. (#320) 2025-10-31 12:55:12 +01:00
providers docs: Azure OpenAI update; create 'Providers' section in mkdocs.yml and specify configuration for CAI to work correctly (#264) (#273) 2025-09-17 11:17:27 +02:00
ref tools api 2025-05-14 12:06:08 +02:00
stylesheets modifs 2025-05-14 12:59:21 +02:00
tui Docs/Adds comprehensive documentation for the CAI Terminal User Interface (TUI), covering all aspects from basic usage to advanced features. (#320) 2025-10-31 12:55:12 +01:00
voice Fix paths in docs 2025-03-28 08:35:25 +01:00
agents.md Expansion of `agents.md` with detailed documentation for all available agents, usage guides, and best practices. (#299) 2025-10-21 16:15:22 +02:00
cai_architecture.md Update docs including guardrails 2025-08-29 14:01:42 +00:00
cai_benchmark.md Extended CAIBench README (#311) 2025-10-28 14:38:07 +01:00
cai_citation_and_acknowledgments.md new brnach 2025-05-14 11:18:48 +02:00
cai_development.md dev 2025-05-14 12:05:30 +02:00
cai_faq.md add faq license 2025-06-18 08:28:34 +00:00
cai_find_us.md new brnach 2025-05-14 11:18:48 +02:00
cai_installation.md modifs 2025-05-14 11:56:27 +02:00
cai_list_of_models.md docs: Azure OpenAI update; create 'Providers' section in mkdocs.yml and specify configuration for CAI to work correctly (#264) (#273) 2025-09-17 11:17:27 +02:00
cai_prompt_injection.md Prompt injection mitigation (#249) 2025-08-28 20:25:24 +02:00
cai_quickstart.md Update docs including guardrails 2025-08-29 14:01:42 +00:00
config.md Fix paths in docs 2025-03-28 08:35:25 +01:00
context.md new brnach 2025-05-14 11:18:48 +02:00
examples.md formatting updates to examples doc 2025-03-19 14:23:28 -07:00
guardrails.md new brnach 2025-05-14 11:18:48 +02:00
handoffs.md new brnach 2025-05-14 11:18:48 +02:00
index.md Update docs including guardrails 2025-08-29 14:01:42 +00:00
index2.md new brnach 2025-05-14 11:18:48 +02:00
mcp.md new brnach 2025-05-14 11:18:48 +02:00
models.md Fix paths in docs 2025-03-28 08:35:25 +01:00
multi_agent.md add patterns 2025-05-14 12:37:39 +02:00
quickstart.md Fix paths in docs 2025-03-28 08:35:25 +01:00
results.md Fix docs 2025-03-28 07:55:41 +01:00
running_agents.md new brnach 2025-05-14 11:18:48 +02:00
streaming.md new brnach 2025-05-14 11:18:48 +02:00
tools.md review doc 2025-05-14 12:14:33 +02:00
tracing.md Add some bits to docs 2025-05-14 14:44:23 +02:00
tracing_cai.md restructure 2025-05-14 11:25:55 +02:00
usage_tracking.md Revert "Apply code formatting with make format" 2025-06-14 09:51:19 +00:00
visualization.md Update visualization.md 2025-03-25 13:34:45 -04:00