Skip to content

Docs Editor Workflow

The docs editor workflow has two stages:

  1. Operators create and edit document records through the protected API.
  2. Operators publish a record, review the generated MDX, and write it into the Starlight content tree.
  • GET /documents
  • POST /documents
  • PUT /documents/{slug}
  • POST /documents/{slug}/publish

All routes require a Cognito JWT from the main product user pool.

The browser editor is available at /editor/.

Publishing returns:

  • contentPath: the target path under apps/docs/src/content/docs
  • content: generated MDX content

Write the returned content locally with:

Terminal window
scripts/write-published-document.mjs published-document-response.json

Then review the generated file, commit it, and deploy docs.