f1fbe0e29a
Archived 4 completed OpenSpec changes (2026-04-02): - phase-3-enterprise (100/100 tasks) — 6 Phase 3 capabilities synced - devops-documentation (48/48 tasks) — 3 new + 1 merged capability - bedroom-developer-docs (33/33 tasks) — 4 new capabilities synced - engineering-docs (superseded by 2026-03-29 archive) — no tasks Main spec library grows from 21 → 35 capabilities (+14 new): federation, multi-tenancy, oidc, soc2, w3c-dids, webhooks, database, operations, system-overview, api-reference, core-concepts, developer-guides, quick-start + deployment (merged additive requirements) Active changes: 0 — project board is clear for Phase 4 planning. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2.5 KiB
2.5 KiB
ADDED Requirements
Requirement: Quick-start guide exists at docs/developers/quick-start.md
The system SHALL provide a quick-start guide at docs/developers/quick-start.md that enables a bedroom developer to register their first agent and issue an OAuth 2.0 access token in under 5 minutes.
Scenario: Developer completes quick-start from zero
- WHEN a developer with no prior AgentIdP knowledge follows the quick-start guide
- THEN they SHALL have a registered agent, a valid credential, and a working access token by the end
Requirement: Quick-start lists exact prerequisites
The quick-start guide SHALL list all prerequisites at the top before any steps, so the developer knows what they need before starting.
Scenario: Prerequisites are minimal and explicit
- WHEN the developer reads the prerequisites section
- THEN they SHALL see exactly: Docker (for running PostgreSQL and Redis) and curl (for API calls) — nothing else required
Requirement: Quick-start provides a working docker-compose startup command
The quick-start guide SHALL include a single command to start the required infrastructure (PostgreSQL + Redis) using the project's docker-compose.yml.
Scenario: Developer starts infrastructure
- WHEN the developer runs the provided docker-compose command
- THEN the guide SHALL confirm what services are started and what ports they run on
Requirement: Quick-start covers the full 4-step workflow
The quick-start guide SHALL cover exactly these four steps in order, each with a working curl command and the expected response:
- Start the AgentIdP server
- Register an agent (
POST /agents) - Generate a credential (
POST /agents/{agentId}/credentials) - Issue an access token (
POST /token)
Scenario: Each step has a copy-pasteable curl command
- WHEN the developer reads any step
- THEN they SHALL find a complete curl command with real placeholder values they can substitute
Scenario: Each step shows the expected JSON response
- WHEN the developer runs a curl command from the guide
- THEN the guide SHALL show them what a successful response looks like so they can verify their output
Requirement: Quick-start ends with a next-steps section
The quick-start guide SHALL end with a "What's Next" section linking to: core-concepts.md, developer-guides.md, and api-reference.md.
Scenario: Developer knows where to go after quick-start
- WHEN the developer reaches the end of the quick-start
- THEN they SHALL see at least 3 links to deeper documentation