Help, docs, brand surfaces, and generated references

Simple terms

This is the documentation and support layer for users, operators, and developers.

The support layer for understanding Apex, finding help, sharing brand context, and inspecting machine-readable API documentation.

Routes

• /docs
• /help
• /brand
• /api/v1/openapi.json

Implementation behavior

• The docs route uses the supplied Apex Docs HTML design as the visual source of truth and renders the product manual from generated MDX content.
• The complete catalog documents every app route surface, while the API surface map documents route-handler families.
• The generated endpoint reference is built from the local OpenAPI spec so public API docs stay aligned with code.
• Help and brand routes provide user support and brand-facing collateral.

How to use it

• Use Feature manuals for how each product area works.
• Use Complete feature catalog when you need the route-level map.
• Use API surface and Endpoint reference when integrating or debugging automation.
• Use Help for support flows that are not specific to implementation details.

When not to use it

• Do not treat docs as a replacement for live QA or current production monitoring.
• Do not rely on the OpenAPI reference for internal dashboard APIs; it only covers public v1.
• Do not let screenshots drift after major UI changes.

Implementation source

• Docs live in content/docs and render through the generated manifest/MDX pipeline; src/app/docs/layout.tsx provides the shell.
• OpenAPI source lives in src/lib/api/openapi-spec and is served at /api/v1/openapi.json.
• Product shots live under public/docs/product-shots.

Data and API

• Docs page data lives in content/docs and the docs manifest/parser pipeline.
• OpenAPI source lives in src/lib/api/openapi-spec and is served at /api/v1/openapi.json.
• Product shots are stored in public/docs/product-shots.

Failure modes

• Docs drift when new routes or APIs are added without updating the manual and catalogs.
• OpenAPI only covers public v1 endpoints; internal APIs need the API surface map.
• Product shots need to be refreshed after major UI changes.