Bloom Docs

Bloom Docs

Generated API references, structured contracts, and internal service documentation for Bloom web services.

API references

The API reference tabs are powered by Scalar Docs navigation and checked specs committed in this repository:

Current coverage

pnpm docs:api:check gates all five known service surfaces:

Beyond API docs

This Scalar Docs site is the home for more than generated API reference pages. Runbooks, integration guides, architecture notes, service ownership, deployment instructions, and incident procedures can be added as Markdown/MDX routes under the same navigation model.

Local preview

Run:

pnpm docs:scalar:preview

The first run downloads Scalar's docs runtime from cdn.scalar.com, which is currently a large archive.