Catalogue Manifest
This page mirrors the API docs catalogue that is checked by pnpm docs:api:check.
| Surface | Docs route | Source |
|---|---|---|
| Backend | /backend |
apps/backend/swagger.json |
| Token Manager | /token-manager |
apps/token-manager/swagger.json |
| Portfolio Manager | /portfolio-manager |
apps/portfolio-manager/openapi.json |
| Notification Manager | /notification-manager |
apps/notification-manager/swagger.json |
| WebSocket Contract | /websocket-contract |
apps/websocket-manager/websocket-contract.json |
The intended CI flow is:
- Run
pnpm docs:api:check. - Run
pnpm docs:scalar:check. - Run
pnpm docs:scalar:build. - Publish
dist/scalar-docsto Cloudflare Pages from the checked repository state.
The API reference routes are rendered by Scalar's @scalar/api-reference browser package. The static site wrapper is built from scalar.config.json so the deployed Cloudflare Pages site follows the same docs catalogue as local Scalar validation.