feat(docs): simplify main README quick start v2#100
feat(docs): simplify main README quick start v2#100abhinav-galileo wants to merge 7 commits intomainfrom
Conversation
README.md
Outdated
| Choose the path you want: | ||
|
|
||
| Startup Agent Control server manually for local development. | ||
| - Visual setup: follow the [UI Quickstart](https://docs.agentcontrol.dev/core/ui-quickstart) |
There was a problem hiding this comment.
I still think here, we should add link to main Quick Start as it has link to UI-Quick start too.
- Working code examples: browse [examples/README.md](examples/README.md) feels misplaced in this section
There was a problem hiding this comment.
- added main quick start
- working "code" examples is fine, no?
There was a problem hiding this comment.
It just feels misplaced in the Add Controls section.
If we can add it outside this section following right after, that will be great
abhinav-galileo
changed the title
abhinav-galileo
requested review from
lan17,
namrataghadi-galileo,
samgdf,
siddhant-galileo,
soumya-io and
yashsheth46
…t diagram Align hero copy with docs website (policy-based control layer), replace placeholder Step 3 with a runnable @control() + ControlViolationError example, add AgentControlDiagram.png before Quick Start, link title to agentcontrol.dev, and replace Local Development section with docs links.
| Protect your AI agent in 4 simple steps. | ||
|  | ||
|
|
||
| ## Quick Start |
There was a problem hiding this comment.
What about the docker compose start if you just wanna run agent control server ?
There was a problem hiding this comment.
it is still there in readme
README.md
Outdated
| --- | ||
| 1. Start the server | ||
| 2. Install the SDK | ||
| 3. Wrap a model or tool call with `@control()` |
There was a problem hiding this comment.
We should point out that this is only needed when integration is not available.
4 participants
No description provided.