8cabc0191c
- devops docs: 8 files updated for Phase 6 state; field-trial.md added (946-line runbook) - developer docs: api-reference (50+ endpoints), quick-start, 5 existing guides updated, 5 new guides added - engineering docs: all 12 files updated (services, architecture, SDK guide, testing, overview) - OpenSpec archives: phase-7-devops-field-trial, developer-docs-phase6-update, engineering-docs-phase6-update - VALIDATOR.md + scripts/start-validator.sh: V&V Architect tooling added - .gitignore: exclude session artifacts, build artifacts, and agent workspaces Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2.9 KiB
2.9 KiB
WS5 Spec — README.md
Target file
docs/developers/README.md
Objective
Two surgical edits to the existing file:
- Fix the "bedroom developers" typo in line 3.
- Expand the Guides table to list all 9 guides (4 existing + 5 new).
Edit 1 — Fix typo in the opening paragraph
Location: Line 3 of the file (the subtitle/description line).
Find (exact text):
The complete documentation for bedroom developers building with SentryAgent.ai AgentIdP.
Replace with:
The complete documentation for developers building with SentryAgent.ai AgentIdP.
No other changes to this paragraph.
Edit 2 — Expand the Guides table
Find (the entire Guides section, from heading to end of table):
## Guides
| Guide | What it covers |
|-------|----------------|
| [Register an Agent](guides/register-an-agent.md) | All fields, validation rules, common errors |
| [Manage Credentials](guides/manage-credentials.md) | Generate, list, rotate, revoke credentials |
| [Issue and Revoke Tokens](guides/issue-and-revoke-tokens.md) | OAuth 2.0 client credentials flow, introspect, revoke |
| [Query Audit Logs](guides/query-audit-logs.md) | Filters, pagination, event structure, retention |
Replace with:
## Guides
| Guide | What it covers |
|-------|----------------|
| [Register an Agent](guides/register-an-agent.md) | All fields, org scoping, validation rules, common errors |
| [Manage Credentials](guides/manage-credentials.md) | Generate, list, rotate, revoke credentials |
| [Issue and Revoke Tokens](guides/issue-and-revoke-tokens.md) | OAuth 2.0 client credentials flow, introspect, revoke |
| [Query Audit Logs](guides/query-audit-logs.md) | Filters, pagination, event structure, retention |
| [Use the Analytics Dashboard](guides/use-analytics-dashboard.md) | Query token trends, activity heatmap, per-agent usage |
| [Manage API Tiers](guides/manage-api-tiers.md) | Check current tier, understand limits, trigger upgrade |
| [A2A Delegation](guides/a2a-delegation.md) | Create and verify agent-to-agent delegation chains |
| [Configure Webhooks](guides/configure-webhooks.md) | Subscribe to events, delivery guarantees, inspect history |
| [AGNTCY Compliance](guides/agntcy-compliance.md) | Export agent cards, generate compliance reports, verify audit chain |
Verification checklist
After both edits:
- Line 3 must read:
The complete documentation for developers building with SentryAgent.ai AgentIdP. - The Documents table (the first table in the file, listing Quick Start / Core Concepts / Guides / API Reference) is unchanged.
- The Guides table has exactly 9 rows.
- All guide filenames match exactly the files that WS4 will create:
guides/use-analytics-dashboard.mdguides/manage-api-tiers.mdguides/a2a-delegation.mdguides/configure-webhooks.mdguides/agntcy-compliance.md
- The Free Tier Limits table at the bottom of the file is unchanged.
- The Base URL section is unchanged.