Skip to content

Commit ef9a79b

Browse files
committed
docs: fix documentation discrepancies across repo
1 parent c983725 commit ef9a79b

4 files changed

Lines changed: 29 additions & 14 deletions

File tree

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.PHONY: help sync openapi-spec openapi-spec-check test test-extras test-all test-models test-sdk lint lint-fix typecheck check build build-models build-server build-sdk publish publish-models publish-server publish-sdk hooks-install hooks-uninstall prepush evaluators-test evaluators-lint evaluators-lint-fix evaluators-typecheck evaluators-build galileo-test galileo-lint galileo-lint-fix galileo-typecheck galileo-build sdk-ts-generate sdk-ts-overlay-test sdk-ts-name-check sdk-ts-generate-check sdk-ts-build sdk-ts-test sdk-ts-lint sdk-ts-typecheck sdk-ts-release-check sdk-ts-publish-dry-run sdk-ts-publish
1+
.PHONY: help sync openapi-spec openapi-spec-check test test-extras test-all test-sdk lint lint-fix typecheck check build build-models build-server build-sdk publish publish-models publish-server publish-sdk hooks-install hooks-uninstall prepush evaluators-test evaluators-lint evaluators-lint-fix evaluators-typecheck evaluators-build galileo-test galileo-lint galileo-lint-fix galileo-typecheck galileo-build sdk-ts-generate sdk-ts-overlay-test sdk-ts-name-check sdk-ts-generate-check sdk-ts-build sdk-ts-test sdk-ts-lint sdk-ts-typecheck sdk-ts-release-check sdk-ts-publish-dry-run sdk-ts-publish
22

33
# Workspace package names
44
PACK_MODELS := agent-control-models

‎README.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ Explore real-world integrations with popular agent frameworks, or jump to [Quick
4949
- **[Galileo Luna-2 Integration](examples/galileo/)** — AI-powered toxicity detection
5050
- **[CrewAI SDK Integration](examples/crewai/)** — Working example on integrating with third party Agent SDKs and using Agent Control along side their guardrails
5151
- **[DeepEval Integration](examples/deepeval/)** — Working Example on How to create custom evaluators to use with your controls
52+
- **[Agent Control Demo](examples/agent_control_demo/)** — Basic agent control demonstration
53+
- **[Steer Action Demo](examples/steer_action_demo/)** — Example of using the steer action for correction and retry
54+
- **[Strands Agents](examples/strands_agents/)** — Integration with Strands Agents framework
5255

5356
## Quick start
5457

@@ -290,12 +293,13 @@ Agent Control is built as a monorepo with these components:
290293

291294
```
292295
agent-control/
293-
├── sdks/python/ # Python SDK (agent-control)
296+
├── sdks/python/ # Python SDK (agent-control-sdk)
294297
├── sdks/typescript/ # TypeScript SDK (generated)
295298
├── server/ # FastAPI server (agent-control-server)
296299
├── engine/ # Evaluation engine (agent-control-engine)
297300
├── models/ # Shared models (agent-control-models)
298301
├── evaluators/ # Evaluator implementations (agent-control-evaluators)
302+
├── scripts/ # Build and utility scripts
299303
├── ui/ # Next.js web dashboard
300304
└── examples/ # Usage examples
301305
```
@@ -334,7 +338,7 @@ For detailed development workflows, see [CONTRIBUTING.md](CONTRIBUTING.md).
334338
- **[Python SDK](sdks/python/README.md)** — SDK installation, usage, and API reference
335339
- **[Server](server/README.md)** — Server setup, configuration, and deployment
336340
- **[UI Dashboard](ui/README.md)** — Web dashboard setup and usage
337-
- **[Evaluators](evaluators/README.md)** — Available evaluators and custom evaluator development
341+
- **[Evaluators](evaluators/builtin/README.md)** — Available evaluators and custom evaluator development
338342

339343
## Contributing
340344

‎docs/OVERVIEW.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -590,15 +590,15 @@ class ContentModerationEvaluator(Evaluator[ContentModerationEvaluatorConfig]):
590590

591591
```bash
592592
# Core SDK
593-
pip install agent-control
593+
pip install agent-control-sdk
594594

595595
# Server
596596
pip install agent-control-server
597597

598598
# With Galileo Luna-2 evaluator support
599599
pip install agent-control-evaluator-galileo
600600
# Or via convenience extra:
601-
pip install agent-control-server[galileo]
601+
pip install agent-control-evaluators[galileo]
602602
```
603603

604604
### Quick Start
@@ -646,10 +646,10 @@ docker-compose up
646646

647647
## Roadmap
648648

649-
- [ ] Web UI for control management
649+
- [x] Web UI for control management
650650
- [ ] More built-in evaluators (OpenAI Moderation, Perspective API, etc.)
651-
- [ ] Metrics and analytics dashboard
652-
- [ ] Multi-language SDK support (TypeScript, Go)
651+
- [x] Metrics and analytics dashboard
652+
- [ ] Multi-language SDK support expansion (Go)
653653
- [ ] Webhook notifications for violations
654654

655655
---

‎server/README.md‎

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -183,18 +183,29 @@ GET /api/v1/agents/{agent_name}/controls
183183
184184
```bash
185185
# Create control
186-
POST /api/v1/controls
187-
Body: { "control": {...} }
186+
PUT /api/v1/controls
187+
Body: { "name": "my-control" }
188188

189189
# List controls
190-
GET /api/v1/controls?skip=0&limit=100
190+
GET /api/v1/controls?cursor=123&limit=100
191191

192192
# Get control
193193
GET /api/v1/controls/{control_id}
194194

195-
# Update control
196-
PUT /api/v1/controls/{control_id}
197-
Body: { "control": {...} }
195+
# Get control data
196+
GET /api/v1/controls/{control_id}/data
197+
198+
# Update control metadata
199+
PATCH /api/v1/controls/{control_id}
200+
Body: { "name": "new-name", "enabled": true }
201+
202+
# Update control data
203+
PUT /api/v1/controls/{control_id}/data
204+
Body: { "data": {...} }
205+
206+
# Validate control data without saving
207+
POST /api/v1/controls/validate
208+
Body: { "data": {...} }
198209

199210
# Delete control
200211
DELETE /api/v1/controls/{control_id}

0 commit comments

Comments
 (0)