sentryagent-idp/openspec/changes/bedroom-developer-docs/proposal.md at eced5f8699e5eb126d107d2b79de00158b1c9db4

Files

SentryAgent.ai Developer 61ea975c79 docs: bedroom developer documentation — complete docs/developers/ set

Adds the full bedroom-developer-docs OpenSpec change implementation:

- docs/developers/README.md — index page
- docs/developers/quick-start.md — bootstrap to working token in 7 steps
- docs/developers/concepts.md — AgentIdP, AGNTCY, lifecycle, OAuth 2.0, free tier
- docs/developers/guides/README.md — guide index
- docs/developers/guides/register-an-agent.md — all fields, validation, common errors
- docs/developers/guides/manage-credentials.md — generate, list, rotate, revoke
- docs/developers/guides/issue-and-revoke-tokens.md — OAuth 2.0 flow, introspect, revoke
- docs/developers/guides/query-audit-logs.md — filters, pagination, 90-day retention
- docs/developers/api-reference.md — all 14 endpoints, all error codes, curl examples

Also commits deferred OpenSpec housekeeping from previous session:
- Archives phase-1-mvp-implementation change to openspec/changes/archive/
- Adds bedroom-developer-docs change artifacts (30/30 tasks complete)
- Syncs 4 delta specs to openspec/specs/

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

2026-03-28 14:13:03 +00:00

2.0 KiB

Raw Blame History

Why

SentryAgent.ai AgentIdP Phase 1 MVP is fully implemented, tested, and live — but there is zero human-readable documentation for the developers we are building this for. A bedroom developer landing on this repo today cannot register their first agent without reading raw OpenAPI YAML or diving into source code. We fix that now.

What Changes

New docs/developers/ folder containing a complete, self-contained documentation set for bedroom developers
Quick-start guide: first agent registered and authenticated in under 5 minutes
Core concepts doc: plain-English explanation of AgentIdP, AGNTCY alignment, and the agent identity model
Step-by-step guides: agent registration, credential management, token issuance, audit log queries
Human-friendly API reference: every endpoint documented with real curl examples and response samples
FAQ: common errors, gotchas, and free-tier limits explained
All docs written for a bedroom developer audience — no enterprise jargon, no assumed knowledge

Capabilities

New Capabilities

quick-start: 5-minute guide from zero to first authenticated agent request — install, register, credential, token, done
core-concepts: Plain-English explanation of what AgentIdP is, how it relates to AGNTCY, the agent identity lifecycle, and why it matters
developer-guides: Step-by-step tutorials for the four core workflows: registering an agent, managing credentials, issuing and revoking tokens, querying the audit log
api-reference: Human-friendly API reference covering all 14 endpoints with real examples, field descriptions, error codes, and rate limit notes

Modified Capabilities

(none — this change introduces documentation only; no existing API specs are modified)

Impact

New folder: docs/developers/ (7 markdown files)
No code changes — documentation only
No new dependencies
No API changes
Existing docs/openapi/ specs are reference material for the Technical Writer but are not modified

2.0 KiB Raw Blame History

Why