Skip to main content

Documentation release process

Feature, screenshot, and documentation changes ship in the same pull request. Git and the pull request are the source of truth; Figma, Notion, and ad hoc screenshot folders can support review but are not canonical.

Pull request gate​

  • Screen inventory is updated.
  • Changed screen contracts, workflows, setup guides, and how-tos are updated.
  • Screenshot manifest/automation is updated for visibly changed states.
  • Maestro and Playwright evidence is linked for critical paths.
  • Roles, permissions, audit, analytics, error, offline, responsive, and accessibility behaviour are reviewed.
  • Release note states who is affected, limitations, migration, and retraining requirements.

Run pnpm seed:website-demo, then the relevant Maestro and Playwright workflows before approving screenshot changes. After merging the product change, sync this canonical documentation into noxorigin-docs with pnpm sync:nox-billings, review the portal preview, and publish the central portal build with pnpm build.