Docs Workflow
How NotifyHub publishes narrative docs and API reference from the standalone docs app.
NotifyHub treats documentation as its own product surface.
Source of truth
- Public route schemas and metadata live in
apps/web. - Generated OpenAPI artifacts belong in
packages/api-types. apps/docsconsumes those artifacts and renders the public docs site.
Route model
/docsserves narrative MDX pages./docs/openapi/*serves virtual API reference pages generated byfumadocs-openapi.- The docs app does not require the dashboard runtime to expose
/api/openapi.
Build order
- Update route schemas and contract metadata.
- Generate the OpenAPI artifact.
- Run or build
apps/docs; its scripts refresh the package artifact before Fumadocs loads it.
Artifact location
apps/docs reads the generated packages/api-types/openapi.json artifact directly.
NotifyHub Docs
Public documentation, package guidance, and generated API reference for NotifyHub.
Issue session token POST
Issues an HMAC-HS256 JWT that a recipient's browser client can use to authenticate with the realtime gateway and the /v1/me/* endpoints. The token embeds the recipient's external id and optional scopes. Provide an `expiresIn` value (number of seconds or a duration string like "1h") to control token lifetime; defaults to 1 hour. If the recipient does not yet exist, it is created automatically with the provided profile fields.