Documentation Status

Coverage Policy

Athena documentation uses a hybrid model:

• generated operation reference from OpenAPI contracts
• curated guides for workflows and operational context

Coverage target for Athena platform routes:

• 100% of operations from openapi.yaml and openapi-wss.yaml must be present in generated Athena reference pages.

Verification Commands

cd apps/docs
npm run openapi:generate
npm run openapi:verify-athena
npm run types:check
npm run build

Expected outcome:

• route coverage verifier reports full operation coverage
• docs types check passes
• docs production build passes

CI Gate

Pull requests and pushes touching docs or OpenAPI contracts are validated by:

• .github/workflows/docs-route-coverage.yml

This workflow performs generation, route-coverage verification, type checks, and docs build.

Source of Truth

Route contracts:

• openapi.yaml
• openapi-wss.yaml

Generated Athena reference location:

• apps/docs/content/docs/reference/athena-openapi

Generated Athena Auth reference location:

• apps/docs/content/docs/reference/openapi