Maintenance and QA

Use this checklist to keep developer docs aligned with implementation.

Documentation QA Checklist

• Verify auth header requirements against api/internal/auth/middleware.go.
• Verify route lists against api/internal/httpapi/server.go.
• Verify configuration tables against api/internal/config/config.go.
• Verify worker behavior claims against api/cmd/worker/main.go.
• Verify plugin SDK examples against plugins/shared-senterail-sdk.ts.
• Verify OpenAPI paths and schemas against API handlers.
• Validate links and examples after every doc release.
• Verify /developers handoff behavior for both local and production docs targets.

Update Triggers

Update docs immediately when any of the following changes:

• New route added, removed, or moved in server.go
• Auth middleware behavior changes
• Config fields/defaults change in config.go
• Worker cadence or queue handling changes in worker/main.go
• Plugin SDK request/response shape changes
• OpenAPI contract changes
• Landing page or developer CTA route changes in ops-ui

Ownership Guidance

• API team owns route/auth/config correctness.
• Plugin team owns SDK/plugin docs correctness.
• Ops team owns runbook execution correctness.
• Product/docs owner owns IA consistency and publishing cadence.

Source-of-Truth Map

Area	Source File	Primary Owner
Authentication behavior	api/internal/auth/middleware.go	API team
Route registration	api/internal/httpapi/server.go	API team
Runtime configuration	api/internal/config/config.go	Platform team
Worker behavior	api/cmd/worker/main.go	Platform team
Canonical OpenAPI	docs/openapi/senterail-api-v1.yaml	API team
Public OpenAPI mirror	developer-docs/docs/public/openapi/senterail-api-v1.yaml	Docs owner

OpenAPI Mirror Sync Rule

When docs/openapi/senterail-api-v1.yaml changes:

1. Apply equivalent updates to developer-docs/docs/public/openapi/senterail-api-v1.yaml.
2. Rebuild docs and verify /openapi/ renders the expected routes.
3. Document meaningful contract changes in release notes or PR summary.

Required PR Checklist For Docs-Affecting Changes

• [ ] Updated docs for changed APIs/config/routes.
• [ ] Updated maintenance.md if ownership or triggers changed.
• [ ] Verified local docs build and app build.