@@ -7,239 +7,146 @@ title: Documentation Index
77
88Complete documentation for the Agentic Ops Framework (AOF).
99
10- ## 📚 Documentation Structure
10+ ## Documentation Structure
1111
1212### Main README
1313- ** [ Project README] ( https://github.com/agenticdevops/aof ) ** - Project overview, quick install, 30-second example
1414
1515### Getting Started
16- - ** [ Getting Started] ( getting-started ) ** - 5-minute quickstart guide
16+ - ** [ Getting Started] ( /docs/ getting-started) ** - 5-minute quickstart guide
1717 - Installation options (cargo, binary, source)
1818 - API key configuration
1919 - First agent creation and execution
2020 - Common troubleshooting
2121
2222### Core Concepts
23- - ** [ Core Concepts] ( concepts ) ** - Understanding AOF fundamentals
23+ - ** [ Core Concepts] ( /docs/ concepts) ** - Understanding AOF fundamentals
2424 - Agents - Single AI assistants
25- - AgentFleets - Teams of agents
26- - AgentFlows - Workflow automation
25+ - AgentFleets - Teams of agents (planned)
26+ - AgentFlows - Workflow automation (planned)
2727 - Tools - MCP, Shell, HTTP, integrations
2828 - Models - Multi-provider support
2929 - Memory - Context persistence
3030
3131### Tutorials (Step-by-Step)
32- 1 . ** [ Build Your First Agent] ( tutorials/first-agent ) ** (15 min)
32+ 1 . ** [ Build Your First Agent] ( /docs/ tutorials/first-agent) ** (15 min)
3333 - Agent definition and configuration
3434 - Adding tools (Shell, MCP)
3535 - Memory management
3636 - Deployment and testing
3737
38- 2 . ** [ Create a Slack Bot] ( tutorials/slack-bot ) ** (20 min)
38+ 2 . ** [ Create a Slack Bot] ( /docs/ tutorials/slack-bot) ** (20 min)
3939 - Slack app setup
4040 - Event handling
4141 - Human-in-the-loop approvals
4242 - Interactive features
4343
44- 3 . ** [ Incident Response Flow] ( tutorials/incident-response ) ** (30 min)
44+ 3 . ** [ Incident Response Flow] ( /docs/ tutorials/incident-response) ** (30 min)
4545 - PagerDuty integration
4646 - Auto-diagnostics
4747 - Conditional remediation
4848 - Post-incident analysis
4949
5050### Reference Documentation
51- - ** [ Agent YAML Spec] ( reference/agent-spec ) ** - Complete Agent specification
51+ - ** [ Agent YAML Spec] ( /docs/ reference/agent-spec) ** - Complete Agent specification
5252 - Metadata fields
5353 - Model configuration
5454 - Instructions best practices
5555 - All tool types (Shell, HTTP, MCP, Slack, GitHub, etc.)
5656 - Memory types and configuration
5757 - Complete examples
5858
59- - ** [ AgentFlow YAML Spec] ( reference/agentflow-spec ) ** - Complete AgentFlow specification
60- - 8 trigger types (Webhook, Schedule, Slack, GitHub, etc.)
61- - 9 node types (Agent, Fleet, HTTP, Shell, Conditional, etc.)
59+ - ** [ AgentFlow YAML Spec] ( /docs/ reference/agentflow-spec) ** - Complete AgentFlow specification
60+ - Trigger types (Webhook, Schedule, Slack, GitHub, etc.)
61+ - Node types (Agent, Fleet, HTTP, Shell, Conditional, etc.)
6262 - Connections and conditions
6363 - Variable interpolation
6464 - Error handling
6565
66- - ** [ aofctl CLI Reference] ( reference/aofctl ) ** - Complete CLI command reference
67- - Agent commands (apply, get, run, chat, exec, logs, etc.)
68- - Fleet commands (create, scale, exec, status)
69- - Flow commands (apply, run, status, visualize)
70- - Config management
66+ - ** [ aofctl CLI Reference] ( /docs/reference/aofctl ) ** - Complete CLI command reference
67+ - Agent commands (apply, get, run, describe, logs, etc.)
7168 - Examples and troubleshooting
7269
7370### Examples (Copy-Paste Ready)
74- - ** [ Examples Overview] ( examples/ ) ** - Overview of all examples
75-
76- #### Production-Ready Examples:
77- 1 . ** [ kubernetes-agent.yaml] ( examples/#1-kubernetes-operations-agent ) **
78- - Interactive K8s cluster management
79- - Safe kubectl execution
80- - Pod/deployment troubleshooting
81-
82- 2 . ** [ github-pr-reviewer.yaml] ( examples/#2-github-pr-review-agent ) **
83- - Automated code review
84- - Security scanning
85- - Best practices enforcement
86- - Automated PR comments
87-
88- 3 . ** [ incident-responder.yaml] ( examples/#3-incident-response-system ) **
89- - PagerDuty webhook integration
90- - Intelligent diagnostics
91- - Auto-remediation with approvals
92- - Incident tracking
93-
94- 4 . ** [ slack-bot-flow.yaml] ( examples/#4-slack-bot-with-interactive-features ) **
95- - Conversational K8s assistant
96- - Interactive approvals
97- - Daily reports
98- - Slash commands
99-
100- 5 . ** [ daily-report-flow.yaml] ( examples/#5-dailyweekly-reports ) **
101- - Scheduled cluster health reports
102- - Weekly summaries
103- - Custom on-demand reports
104-
105- ## 📖 Recommended Reading Path
71+ - ** [ Examples Overview] ( /docs/examples ) ** - Overview of all examples with copy-paste YAML
72+
73+ ## Recommended Reading Path
10674
10775### For First-Time Users:
108761 . Start with ** [ Project README] ( https://github.com/agenticdevops/aof ) ** - Understand what AOF is
109- 2 . Follow ** [ Getting Started] ( getting-started ) ** - Get up and running
110- 3 . Read ** [ Core Concepts] ( concepts ) ** - Understand the building blocks
111- 4 . Try ** [ First Agent Tutorial] ( tutorials/first-agent ) ** - Hands-on practice
77+ 2 . Follow ** [ Getting Started] ( /docs/ getting-started) ** - Get up and running
78+ 3 . Read ** [ Core Concepts] ( /docs/ concepts) ** - Understand the building blocks
79+ 4 . Try ** [ First Agent Tutorial] ( /docs/ tutorials/first-agent) ** - Hands-on practice
11280
11381### For Production Deployment:
114- 1 . Review ** [ Agent Spec] ( reference/agent-spec ) ** - Understand all options
115- 2 . Study ** [ Examples] ( examples/ ) ** - See production patterns
116- 3 . Read ** [ AgentFlow Spec] ( reference/agentflow-spec ) ** - Learn workflow automation
117- 4 . Check ** [ CLI Reference] ( reference/aofctl ) ** - Master the tools
118-
119- ### For Specific Use Cases:
120- - ** Slack Bot** : [ Slack Bot Tutorial] ( tutorials/slack-bot ) + [ slack-bot-flow.yaml] ( examples/#4-slack-bot-with-interactive-features )
121- - ** Incident Response** : [ Incident Response Tutorial] ( tutorials/incident-response ) + [ incident-responder.yaml] ( examples/#3-incident-response-system )
122- - ** Code Review** : [ github-pr-reviewer.yaml] ( examples/#2-github-pr-review-agent )
123- - ** K8s Operations** : [ kubernetes-agent.yaml] ( examples/#1-kubernetes-operations-agent )
82+ 1 . Review ** [ Agent Spec] ( /docs/reference/agent-spec ) ** - Understand all options
83+ 2 . Study ** [ Examples] ( /docs/examples ) ** - See production patterns
84+ 3 . Check ** [ CLI Reference] ( /docs/reference/aofctl ) ** - Master the tools
12485
125- ## 🎯 Documentation by Role
86+ ## Documentation by Role
12687
12788### DevOps Engineers
12889Essential reading:
129- - [ Getting Started] ( getting-started )
130- - [ kubernetes-agent.yaml] ( examples/#1-kubernetes-operations-agent )
131- - [ incident-responder.yaml] ( examples/#3-incident-response-system )
132- - [ Agent Spec] ( reference/agent-spec ) (Tools section)
90+ - [ Getting Started] ( /docs/getting-started )
91+ - [ Examples] ( /docs/examples )
92+ - [ Agent Spec] ( /docs/reference/agent-spec ) (Tools section)
13393
13494### SRE Teams
13595Essential reading:
136- - [ Core Concepts] ( concepts )
137- - [ Incident Response Tutorial] ( tutorials/incident-response )
138- - [ incident-responder.yaml] ( examples/#3-incident-response-system )
139- - [ daily-report-flow.yaml] ( examples/#5-dailyweekly-reports )
96+ - [ Core Concepts] ( /docs/concepts )
97+ - [ Incident Response Tutorial] ( /docs/tutorials/incident-response )
98+ - [ Examples] ( /docs/examples )
14099
141100### Platform Engineers
142101Essential reading:
143- - [ AgentFlow Spec] ( reference/agentflow-spec )
144- - [ All Examples] ( examples/ )
145- - [ CLI Reference] ( reference/aofctl )
102+ - [ AgentFlow Spec] ( /docs/ reference/agentflow-spec)
103+ - [ Examples] ( /docs/examples )
104+ - [ CLI Reference] ( /docs/ reference/aofctl)
146105- All tutorials
147106
148- ## 🔍 Quick Reference
107+ ## Quick Reference
149108
150109### Common Tasks
151110
152111| Task | Documentation |
153112| ------| ---------------|
154- | Install AOF | [ Getting Started] ( getting-started ) |
155- | Create first agent | [ First Agent Tutorial] ( tutorials/first-agent ) |
156- | Add kubectl tools | [ Agent Spec - Tools] ( reference/agent-spec#tool-shell ) |
157- | Build Slack bot | [ Slack Bot Tutorial] ( tutorials/slack-bot ) |
158- | Setup auto-remediation | [ Incident Response Tutorial] ( tutorials/incident-response ) |
159- | Schedule workflows | [ AgentFlow Spec - Schedule Trigger] ( reference/agentflow-spec#schedule ) |
160- | CLI commands | [ aofctl Reference] ( reference/aofctl ) |
161-
162- ### YAML Quick Reference
163-
164- | Resource | Spec Doc | Example |
165- | ----------| ----------| ---------|
166- | Agent | [ agent-spec.md] ( reference/agent-spec ) | [ kubernetes-agent.yaml] ( examples/#1-kubernetes-operations-agent ) |
167- | AgentFleet | [ agent-spec.md] ( reference/agent-spec ) | Coming soon |
168- | AgentFlow | [ agentflow-spec.md] ( reference/agentflow-spec ) | [ slack-bot-flow.yaml] ( examples/#4-slack-bot-with-interactive-features ) |
113+ | Install AOF | [ Getting Started] ( /docs/getting-started ) |
114+ | Create first agent | [ First Agent Tutorial] ( /docs/tutorials/first-agent ) |
115+ | Add kubectl tools | [ Agent Spec - Tools] ( /docs/reference/agent-spec#tool-shell ) |
116+ | Build Slack bot | [ Slack Bot Tutorial] ( /docs/tutorials/slack-bot ) |
117+ | Setup auto-remediation | [ Incident Response Tutorial] ( /docs/tutorials/incident-response ) |
118+ | CLI commands | [ aofctl Reference] ( /docs/reference/aofctl ) |
169119
170120### Model Providers
171121
172- | Provider | Format | Env Variable | Docs |
173- | ----------| --------| --------------| ------|
174- | OpenAI | ` openai:gpt-4 ` | ` OPENAI_API_KEY ` | [ Agent Spec] ( reference/agent-spec#specmodel ) |
175- | Anthropic | ` anthropic:claude-3-5-sonnet-20241022 ` | ` ANTHROPIC_API_KEY ` | [ Agent Spec] ( reference/agent-spec#specmodel ) |
176- | Ollama | ` ollama:llama3 ` | None | [ Agent Spec] ( reference/agent-spec#specmodel ) |
177- | Groq | ` groq:llama-3.1-70b-versatile ` | ` GROQ_API_KEY ` | [ Agent Spec] ( reference/agent-spec#specmodel ) |
178-
179- ## 🛠️ Tool Documentation
122+ | Provider | Format | Env Variable |
123+ | ----------| --------| --------------|
124+ | Google | ` google:gemini-2.5-flash ` | ` GOOGLE_API_KEY ` |
125+ | OpenAI | ` openai:gpt-4o ` | ` OPENAI_API_KEY ` |
126+ | Anthropic | ` anthropic:claude-3-5-sonnet-20241022 ` | ` ANTHROPIC_API_KEY ` |
127+ | Ollama | ` ollama:llama3 ` | None (local) |
180128
181- | Tool Type | Description | Docs |
182- | -----------| -------------| ------|
183- | Shell | Execute terminal commands | [ Agent Spec - Shell] ( reference/agent-spec#tool-shell ) |
184- | HTTP | REST API requests | [ Agent Spec - HTTP] ( reference/agent-spec#tool-http ) |
185- | MCP | Model Context Protocol servers | [ Agent Spec - MCP] ( reference/agent-spec#tool-mcp-model-context-protocol ) |
186- | Slack | Slack integration | [ Agent Spec - Slack] ( reference/agent-spec#tool-slack ) |
187- | GitHub | GitHub API | [ Agent Spec - GitHub] ( reference/agent-spec#tool-github ) |
188- | PagerDuty | Incident management | [ Agent Spec - PagerDuty] ( reference/agent-spec#tool-pagerduty ) |
129+ ### Built-in Tools
189130
190- ## 📝 Contributing
131+ | Tool | Description |
132+ | ------| -------------|
133+ | ` shell ` | Execute shell commands |
134+ | ` read_file ` | Read file contents |
135+ | ` list_directory ` | List directory contents |
136+ | ` git ` | Execute git commands |
191137
192- ### Documentation Contributions
193- - Fix typos or improve clarity
194- - Add missing examples
195- - Update outdated information
196- - Translate to other languages
197-
198- ### Example Contributions
199- See [ Examples README] ( examples/ ) for guidelines.
200-
201- ## 🆘 Getting Help
138+ ## Getting Help
202139
2031401 . ** Check documentation** - Search this index
204- 2 . ** Review examples** - See [ examples ] ( examples/ )
141+ 2 . ** Review examples** - See [ Examples ] ( /docs/examples )
2051423 . ** Troubleshooting** - Check each tutorial's troubleshooting section
2061434 . ** GitHub Issues** - [ Report bugs or request features] ( https://github.com/agenticdevops/aof/issues )
2071445 . ** Discussions** - [ Ask questions] ( https://github.com/agenticdevops/aof/discussions )
208145
209- ## 📊 Documentation Coverage
210-
211- ### ✅ Complete
212- - [x] Main README
213- - [x] Getting Started guide
214- - [x] Core Concepts
215- - [x] 3 comprehensive tutorials
216- - [x] Complete Agent YAML reference
217- - [x] Complete AgentFlow YAML reference
218- - [x] Complete CLI reference
219- - [x] 5 production-ready examples
220-
221- ### 🚧 Coming Soon
222- - [ ] AgentFleet tutorial
223- - [ ] Advanced patterns guide
224- - [ ] Performance tuning guide
225- - [ ] Security best practices
226- - [ ] Migration from other frameworks
227- - [ ] API documentation (if REST API is added)
228-
229- ## 🔄 Documentation Updates
230-
231- Last updated: 2024-01-20
232-
233- ### Recent Changes
234- - Added complete reference documentation
235- - Added 5 production examples
236- - Added 3 step-by-step tutorials
237- - Added quickstart guide
238-
239146---
240147
241- ** Questions?** Start with [ Getting Started] ( getting-started ) or jump to a [ Tutorial] ( tutorials/first-agent ) .
148+ ** Questions?** Start with [ Getting Started] ( /docs/ getting-started) or jump to a [ Tutorial] ( /docs/ tutorials/first-agent) .
242149
243- ** Building something?** Check the [ Examples] ( examples/ ) for copy-paste templates.
150+ ** Building something?** Check the [ Examples] ( /docs/examples ) for copy-paste templates.
244151
245- ** Need details?** See the [ Reference Documentation] ( reference/agent-spec ) .
152+ ** Need details?** See the [ Reference Documentation] ( /docs/ reference/agent-spec) .
0 commit comments