Docs Editor Workflow
The docs editor workflow has two stages:
- Operators create and edit document records through the protected API.
- Operators publish a record, review the generated MDX, and write it into the Starlight content tree.
Protected API
Section titled “Protected API”GET /documentsPOST /documentsPUT /documents/{slug}POST /documents/{slug}/publish
All routes require a Cognito JWT from the main product user pool.
Editor UI
Section titled “Editor UI”The browser editor is available at /editor/.
Publish Workflow
Section titled “Publish Workflow”Publishing returns:
contentPath: the target path underapps/docs/src/content/docscontent: generated MDX content
Write the returned content locally with:
scripts/write-published-document.mjs published-document-response.jsonThen review the generated file, commit it, and deploy docs.