-
-
Notifications
You must be signed in to change notification settings - Fork 8
Open
Labels
area:agent-protocolAgent protocol (sentinel-agent-protocol)Agent protocol (sentinel-agent-protocol)good-first-issueGood for newcomersGood for newcomerstype:docsDocumentation onlyDocumentation only
Description
Summary
The `zentinel-agent-protocol` crate could use better doc comments on its public API types. This makes it easier for agent authors to understand how to use the protocol.
What to document
Key types in `crates/agent-protocol/src/v2/`:
- `AgentPool` — connection pooling and load balancing
- `Decision` — agent response types (Allow, Block, Redirect, Modify)
- `AgentHandlerV2` — trait for implementing agents
- Transport types (`UdsAgentServerV2`, `GrpcAgentServerV2`)
How to contribute
- Read the existing code and `crates/agent-protocol/docs/`
- Add `///` doc comments to public types and methods
- Include `# Errors` sections where applicable
- Run `cargo doc -p zentinel-agent-protocol --no-deps --open` to preview
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
area:agent-protocolAgent protocol (sentinel-agent-protocol)Agent protocol (sentinel-agent-protocol)good-first-issueGood for newcomersGood for newcomerstype:docsDocumentation onlyDocumentation only