Skip to content

Commit 092ea7c

Browse files
skokainaskokaina
committed
docs: add tutorials and group samples
1 parent 4651794 commit 092ea7c

5 files changed

Lines changed: 873 additions & 30 deletions

File tree

‎docs/.vitepress/config.mts‎

Lines changed: 61 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -31,47 +31,86 @@ export default defineConfig({
3131
{ text: 'Quick Start', link: '/quick-start' },
3232
],
3333
},
34+
{
35+
text: 'Tutorials',
36+
items: [
37+
{ text: 'Build a Production Agent', link: '/tutorials/01-build-production-agent' },
38+
{ text: 'Harden an Existing Agent', link: '/tutorials/02-harden-existing-agent' },
39+
{ text: 'Deploy & Monitor', link: '/tutorials/03-deploy-and-monitor' },
40+
],
41+
},
3442
{
3543
text: 'Concepts',
3644
items: [
37-
{ text: 'The Manifest', link: '/concepts/manifest' },
38-
{ text: 'Health Checks', link: '/concepts/health-checks' },
39-
{ text: 'Runtime Introspection', link: '/concepts/runtime-introspection' },
40-
{ text: 'Compliance', link: '/concepts/compliance' },
41-
{ text: 'Adapters', link: '/concepts/adapters' },
45+
{ text: 'The Manifest', link: '/concepts/manifest' },
46+
{ text: 'Health Checks', link: '/concepts/health-checks' },
47+
{ text: 'Runtime Introspection', link: '/concepts/runtime-introspection' },
48+
{ text: 'Compliance', link: '/concepts/compliance' },
49+
{ text: 'Probe Coverage', link: '/concepts/probe-coverage' },
50+
{ text: 'OPA Policies', link: '/concepts/opa' },
51+
{ text: 'Adapters', link: '/concepts/adapters' },
4252
],
4353
},
4454
{
4555
text: 'Guides',
4656
items: [
47-
{ text: 'Add Tools', link: '/guides/add-tools' },
48-
{ text: 'Add Memory', link: '/guides/add-memory' },
49-
{ text: 'Add Guardrails', link: '/guides/add-guardrails' },
50-
{ text: 'Add Runtime Health', link: '/guides/add-runtime-health' },
51-
{ text: 'Add Push Mode', link: '/guides/add-push-mode' },
52-
{ text: 'CI Integration', link: '/guides/ci-integration' },
53-
{ text: 'E2E Testing', link: '/guides/e2e-testing' },
54-
{ text: 'Migrate an Existing Agent', link: '/guides/migrate-existing-agent' },
55-
{ text: 'Migrate GymCoach', link: '/guides/migrate-gymcoach' },
56-
{ text: 'Migrate OpenAGI', link: '/guides/migrate-openagi' },
57-
{ text: 'Migrate SuperAgent', link: '/guides/migrate-superagent' },
58-
{ text: 'Migrate GPT-Researcher', link: '/guides/migrate-gpt-researcher' },
57+
{
58+
text: 'Capabilities',
59+
collapsed: false,
60+
items: [
61+
{ text: 'Add Tools', link: '/guides/add-tools' },
62+
{ text: 'Add Memory', link: '/guides/add-memory' },
63+
{ text: 'Add Guardrails', link: '/guides/add-guardrails' },
64+
],
65+
},
66+
{
67+
text: 'Runtime & Ops',
68+
collapsed: false,
69+
items: [
70+
{ text: 'Add Runtime Health', link: '/guides/add-runtime-health' },
71+
{ text: 'Add Push Mode', link: '/guides/add-push-mode' },
72+
{ text: 'Generate OPA Policy', link: '/guides/opa-policy' },
73+
],
74+
},
75+
{
76+
text: 'Verification & CI',
77+
collapsed: false,
78+
items: [
79+
{ text: 'Integrate Proof Tools', link: '/guides/proof-integration' },
80+
{ text: 'CI Integration', link: '/guides/ci-integration' },
81+
{ text: 'E2E Testing', link: '/guides/e2e-testing' },
82+
],
83+
},
84+
{
85+
text: 'Examples',
86+
collapsed: false,
87+
items: [
88+
{ text: 'Sample: LangGraph Agent', link: '/guides/sample-langgraph-agent' },
89+
{ text: 'Sample: AutoGen Agent', link: '/guides/sample-autogen-agent' },
90+
{ text: 'Migrate Existing Agent', link: '/guides/migrate-existing-agent' },
91+
{ text: 'Migrate GymCoach', link: '/guides/migrate-gymcoach' },
92+
{ text: 'Migrate OpenAGI', link: '/guides/migrate-openagi' },
93+
{ text: 'Migrate SuperAgent', link: '/guides/migrate-superagent' },
94+
{ text: 'Migrate GPT-Researcher', link: '/guides/migrate-gpt-researcher' },
95+
],
96+
},
5997
],
6098
},
6199
{
62100
text: 'Reference',
63101
items: [
64-
{ text: 'CLI', link: '/reference/cli' },
65-
{ text: 'Manifest Schema', link: '/reference/manifest-schema' },
102+
{ text: 'CLI', link: '/reference/cli' },
103+
{ text: 'Manifest Schema', link: '/reference/manifest-schema' },
104+
{ text: 'Operator Helm Values', link: '/reference/operator-helm-values' },
66105
],
67106
},
68107
{
69108
text: 'Adapters',
70109
items: [
71110
{ text: 'LangGraph', link: '/adapters/langgraph' },
72-
{ text: 'CrewAI', link: '/adapters/crewai' },
73-
{ text: 'Mastra', link: '/adapters/mastra' },
74-
{ text: 'AutoGen', link: '/adapters/autogen' },
111+
{ text: 'CrewAI', link: '/adapters/crewai' },
112+
{ text: 'Mastra', link: '/adapters/mastra' },
113+
{ text: 'AutoGen', link: '/adapters/autogen' },
75114
],
76115
},
77116
],

‎docs/quick-start.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -163,11 +163,13 @@ kubectl apply -f ./generated/k8s/deployment.yaml
163163
kubectl apply -f ./generated/k8s/service.yaml
164164
```
165165

166-
## Next Steps
167-
168-
- [Add tools](./guides/add-tools.md)
169-
- [Add memory](./guides/add-memory.md)
170-
- [Add guardrails](./guides/add-guardrails.md)
171-
- [Add push mode](./guides/add-push-mode.md) — real-time health reporting
172-
- [Integrate with CI](./guides/ci-integration.md) — drift detection + compliance gates
173-
- [Full manifest reference](./reference/manifest-schema.md)
166+
## What to do next
167+
168+
| I want to... | Go to |
169+
|---------------------------------------|----------------------------------------------------------------------------------------------|
170+
| Build an agent from scratch | [Tutorial: Build a production agent](./tutorials/01-build-production-agent) |
171+
| Add my existing code to AgentSpec | [Tutorial: Harden an existing agent](./tutorials/02-harden-existing-agent) |
172+
| Deploy with Kubernetes and monitor it | [Tutorial: Deploy & monitor](./tutorials/03-deploy-and-monitor) |
173+
| Understand the manifest fields | [The Manifest](./concepts/manifest) |
174+
| Understand compliance scoring | [Compliance](./concepts/compliance) |
175+
| See all CLI commands | [CLI Reference](./reference/cli) |

0 commit comments

Comments
 (0)