Skip to content

docs: fix documentation discrepancies across README, server docs, and overview - #73

Closed
samgdf wants to merge 1 commit into
mainfrom
docs/fix-documentation-discrepancies
Closed

samgdf wants to merge 1 commit into
mainfrom
docs/fix-documentation-discrepancies

Conversation

@samgdf

@samgdf samgdf commented Mar 8, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

This PR addresses the 11 documentation/repo discrepancies identified for docs/fix-documentation-discrepancies.

Changes

  • Fixed broken Evaluators link in root README to point to evaluators/builtin/README.md.
  • Added missing example entries in root README for:
    • examples/agent_control_demo/
    • examples/steer_action_demo/
    • examples/strands_agents/
  • Updated README directory structure details to:
    • include scripts/
    • clarify Python SDK distribution naming as agent-control-sdk.
  • Corrected Server README control API docs:
    • create endpoint method: PUT /api/v1/controls
    • metadata update method: PATCH /api/v1/controls/{control_id}
    • documented data update endpoint: PUT /api/v1/controls/{control_id}/data
    • documented data read endpoint: GET /api/v1/controls/{control_id}/data
    • documented validation endpoint: POST /api/v1/controls/validate
    • corrected list pagination example to cursor-based (cursor + limit).
  • Updated docs/OVERVIEW.md installation and roadmap:
    • corrected SDK install command to pip install agent-control-sdk
    • aligned Galileo extra install command to pip install agent-control-evaluators[galileo]
    • marked completed roadmap items as done (Web UI, Metrics dashboard)
    • updated SDK roadmap wording to focus on Go expansion (TypeScript already exists).
  • Removed undefined test-models from Makefile .PHONY list.

Validation

  • Ran make help successfully after Makefile update.

@codecov

codecov Bot commented Mar 8, 2026

Copy link
Copy Markdown

The author of this PR, samgdf, is not an activated member of this organization on Codecov.
Please activate this user on Codecov to display this PR comment.
Coverage data is still being uploaded to Codecov.io for purposes of overall coverage calculations.
Please don't hesitate to email us at support@codecov.io with any questions.

Comment thread docs/OVERVIEW.md
pip install agent-control-evaluator-galileo
# Or via convenience extra:
pip install agent-control-server[galileo]
pip install agent-control-evaluators[galileo]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overview is now broken into different articles in the docs repo.
Everything about evaluators is now under Evaluators section in docs. For galileo evaluators, it can be found here.

Comment thread docs/OVERVIEW.md
```bash
# Core SDK
pip install agent-control
pip install agent-control-sdk

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Install SDK in Quickstart

Comment thread docs/OVERVIEW.md
## Roadmap

- [ ] Web UI for control management
- [x] Web UI for control management

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is not in Quick Start anymore in docs

Comment thread README.md
```
agent-control/
├── sdks/python/ # Python SDK (agent-control)
├── sdks/python/ # Python SDK (agent-control-sdk)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added to architecture

@samgdf samgdf closed this Mar 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants