Commit Graph

169 Commits

Author SHA1 Message Date
Daniel Sanchez f49ff99f8c Merge upstream/main to sync with latest changes
- 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
2025-11-03 15:04:06 +01:00
Daniel Sanchez a7109e72bf 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
2025-11-03 14:52:40 +01:00
Víctor Mayoral Vilches fde4c4aef4 minor improvements in docs
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-11-02 14:24:16 +00:00
Víctor Mayoral Vilches f5f3c42eb5 Rework documentation a bit, structure and aesthetics
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-11-01 18:21:14 +00:00
Víctor Mayoral Vilches c7a942eae3 Add CAI PRO badges
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-11-01 09:10:13 +00:00
Víctor Mayoral Vilches 6babb4ad94 Add documentation for /ctx
Signed-off-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-11-01 09:10:07 +00:00
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
Daniel Sanchez aea9e603a9 Merge upstream/main into docs/add-tui-advanced-documentation
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 #311: Extended CAIBench documentation with new benchmark page
- PR #317: Fixed OSX installation documentation
- Added cai_benchmark.md to mkdocs.yml navigation
- Updated benchmarks README and evaluation scripts
- Added benchmark visualization images
2025-10-31 11:18:15 +01:00
Daniel Sanchez 9016c73c8e docs: remove broken link and fix formatting in TUI docs 2025-10-29 15:10:55 +01:00
Daniel Sanchez 32bece9eea docs: update installation guide link to new v0.6 documentation 2025-10-29 15:09:03 +01:00
yuri-alias faf9802d4c
Added missing step in OSX install documentation. (#317)
* added documentation for repl commands and extensions

* added documentation on MCP use, added Chrome example

* added missing step in OSX installation
2025-10-29 14:44:59 +01:00
Daniel Sanchez 688c5b1c50 docs: finalize tui_index - activate all doc links, remove flags and config/faq references 2025-10-29 11:40:46 +01:00
Daniel Sanchez f499ff176f docs: refine troubleshooting - remove install/launch sections, update command references 2025-10-29 11:32:58 +01:00
Daniel Sanchez 20af8587a5 docs: add troubleshooting guide for TUI 2025-10-29 11:17:49 +01:00
Daniel Sanchez d0284f5ef0 docs: remove auto-save reference and help message in advanced_features 2025-10-29 10:43:55 +01:00
Daniel Sanchez 4eb2e2e582 docs: standardize env vars and add guardrails documentation link in advanced_features 2025-10-29 10:34:20 +01:00
Daniel Sanchez 86482421d4 docs: fix MCP configuration guide link path in advanced_features 2025-10-28 18:11:21 +01:00
Daniel Sanchez 41b5e2544c docs: refactor advanced_features - simplify MCP section with link to config guide, update model references, remove deprecated content 2025-10-28 18:07:49 +01:00
Daniel Sanchez df6c65bc89 docs: add advanced_features.md with ICL, MCP, guardrails, and integration guides 2025-10-28 17:55:48 +01:00
Daniel Sanchez c744a533f4 docs: update model references to use alias models in teams_and_parallel_execution 2025-10-28 17:47:00 +01:00
Daniel Sanchez 41e096db04 docs: add teams_and_parallel_execution.md with coordination patterns and strategies 2025-10-28 17:35:13 +01:00
Daniel Sanchez 7f11478188 docs: fix code block formatting in sidebar_features ALIAS1 section 2025-10-28 17:04:04 +01:00
Daniel Sanchez 66a6c46616 docs: update sidebar_features with correct team compositions, ALIAS1 info, and automatic queue behavior 2025-10-28 16:57:11 +01:00
Daniel Sanchez 47523e981f docs: add sidebar_features.md with Teams, Queue, Stats, and Keys tabs documentation 2025-10-28 15:47:01 +01:00
Francesco Balassone cd956813f0
Extended CAIBench README (#311)
* add preliminar files

* add preliminar files

* cai pro foot note

* cadd cyber PII info

* Update monolithsentinel image reference in README

* add ciberPII-bench

* Document Attack-Defense CTF framework in README

Added detailed section on Attack-Defense CTF including game structure, rules, scoring, architecture, and technical features.

* Update benchmarks/README.md

* Update README with Plot skeletons

* Added plots

* Update benchmark plots in README.md

* Added titles

* Add files via upload

* Add files via upload

* Update navigation in mkdocs.yml

---------

Co-authored-by: Maria <maria@aliasrobotics.com>
Co-authored-by: Víctor Mayoral Vilches <v.mayoralv@gmail.com>
2025-10-28 14:38:07 +01:00
Daniel Sanchez f0cc5865c2 docs: minimal fix 2025-10-28 12:51:04 +01:00
Daniel Sanchez 4d45a58e46 docs: fix triple terminal layout description to accurately reflect three-column split 2025-10-28 12:45:10 +01:00
Daniel Sanchez a7c9c6a842 docs: add terminal anatomy screenshot to terminals_management 2025-10-28 12:40:38 +01:00
Daniel Sanchez c72cc12a44 docs: fix formatting issue in terminals_management removing terminals section 2025-10-28 12:34:19 +01:00
Daniel Sanchez 459f403016 docs: add CAI-5+terminals.png screenshot to media folder 2025-10-28 12:30:16 +01:00
Daniel Sanchez 819b190154 docs: add remaining layout images and refine terminals_management content 2025-10-28 12:26:37 +01:00
Daniel Sanchez f381b696ed docs: add terminals_management.md with multi-terminal workflows and layouts 2025-10-28 11:13:37 +01:00
Daniel Sanchez fb54d2abca docs: activate links for completed TUI documentation files 2025-10-27 16:56:02 +01:00
Daniel Sanchez cb5c238ef6 docs: update commands_reference with enhanced agent list, terminal targeting methods, and UI refinements 2025-10-27 16:48:38 +01:00
Daniel Sanchez 93511d8823 docs: add comprehensive commands reference for TUI 2025-10-27 16:33:47 +01:00
Daniel Sanchez 41aef73500 docs: rename files to use underscores for consistency (keyboard_shortcuts, user_interface) 2025-10-27 16:14:02 +01:00
Daniel Sanchez cb41ad1722 Restructure 2025-10-27 15:59:45 +01:00
Daniel Sanchez 9fa18deb01 docs: add comprehensive keyboard shortcuts reference for TUI 2025-10-27 15:45:59 +01:00
Daniel Sanchez 57e16973fd docs: update user-interface content 2025-10-27 15:39:31 +01:00
Daniel Sanchez dd2255d3df Minimal changes 2025-10-27 15:31:48 +01:00
Daniel Sanchez 860447b9c7 docs: improve TUI user-interface with enhanced topbar descriptions, layout screenshots, and reorganized command palette 2025-10-27 15:28:31 +01:00
Daniel Sanchez 16983f2d44 docs: add comprehensive TUI user interface documentation 2025-10-27 12:47:02 +01:00
danielsanchezprieto01 6498ade7da
Add TUI documentation (index + getting started) (#313)
* 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
2025-10-27 12:05:16 +01:00
Daniel Sanchez 5b25cd6cf8 docs: add CAI-Pro exclusive banner to TUI documentation 2025-10-27 11:56:03 +01:00
Daniel Sanchez 456bee795f 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
2025-10-24 14:38:00 +02:00
Daniel Sanchez b98995e9b6 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
2025-10-24 14:17:42 +02:00
Daniel Sanchez 2e8d5dabc2 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
2025-10-24 14:12:46 +02:00
Daniel Sanchez 47e73c1985 docs: minimum change 2025-10-24 14:09:42 +02:00
Daniel Sanchez 29213ed3a8 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
2025-10-24 14:06:44 +02:00
Daniel Sanchez f772b28326 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
2025-10-24 13:56:37 +02:00