Skip to main content

Docs Web API Reference Runway

The API reference route exists in v0, but generated API reference pages do not.

Decision​

API reference generation is deferred until package exports, declaration output, and package stability rules are ready. v0 publishes only a placeholder at /reference/api.

Future Inputs​

The generator may read:

  • package exports maps
  • built .d.ts files from package dist
  • package metadata from package.json
  • public API contract snapshots where they exist
  • package classification from tools/workspace-package-registry.mjs

It must not read source files as the public contract unless a package explicitly declares that source as the contract input.

Future Outputs​

Generated output should be written under an ignored build path, then consumed by Docusaurus. A future shape can be:

apps/docs/.generated/docs/reference/api/
  index.md
  assistant-composition/
  assistant-protocol/
  assistant-ui/

The generator must also emit a manifest with:

  • package name
  • package version
  • source declaration files
  • included export keys
  • skipped export keys with reasons
  • generation timestamp

Package Inclusion Criteria​

A package can enter generated API reference only if:

  • it is listed in tools/workspace-package-registry.mjs
  • it has publicAbiSnapshot: true
  • its build output exists
  • its package docs already describe the public boundary
  • its generated pages do not create a second hand-written API inventory

Non-Goals For v0​

  • no TypeDoc dependency
  • no declaration parser
  • no hand-written symbol pages
  • no generated stability badges
  • no per-symbol compatibility policy

Reopen Criteria​

Implementing API reference generation requires reopening DOCS-ADR-004 with:

  • selected generator approach
  • package inclusion list
  • output route map
  • broken-link behavior
  • verification command
  • ownership and review rules