Prox OS Internal Docs
Development

Quality Gates

Quality gates keep Prox OS safe while humans and AI agents move quickly. They

Purpose

Quality gates keep Prox OS safe while humans and AI agents move quickly. They are feedback controls, not ceremony.

Standard Checks

For non-trivial code changes:

pnpm lint
pnpm typecheck
pnpm arch:check
pnpm check:cjk

For branch-scoped validation in the Nx-first monorepo:

pnpm affected:quality

For broad migrations:

pnpm nx run-many -t lint typecheck --exclude=prox-os
pnpm nx run-many -t build --exclude=prox-os

For structural refactors, package moves, app extraction, state model changes, API boundary changes, or large UI splits:

pnpm check:file-size

For docs changes that should appear in the Fumadocs app:

pnpm docs:sync
pnpm check:cjk

Task-specific Gates

Change typeAdd these checks
Shell layout, desktop, window chrome, responsive UIBrowser inspection or screenshots when practical.
UI primitives or shared visual componentsStorybook/UI Workshop story or explicit note explaining why not.
App registry, route groups, app manifestspnpm arch:check, docs update for app registry or OS apps.
App contract or runtime contextpnpm typecheck, pnpm arch:check, manual human review.
API worker, OpenAPI, MSW, data flowAPI/data-flow docs update and relevant package build/typecheck.
Package boundary or dependency graphpnpm arch:check, pnpm check:file-size, architecture docs update.
Deployment, Cloudflare, domains, AccessDeployment docs update and explicit human approval before production action.
Docs, prompts, app copy, mock datapnpm check:cjk.

Reporting Results

Every agent summary or PR should include:

  • Commands run.
  • Pass/fail status.
  • Exact skipped commands and reasons.
  • Known pre-existing failures.
  • Residual risk.

Do not hide skipped checks behind "not run" without an explanation.

Docs App Sync

Root docs/ is canonical. apps/docs/content/docs is generated by:

pnpm docs:sync

Run it after adding, renaming, deleting, or materially changing docs that should be browseable in the docs app. Do not edit generated apps/docs/content/docs files directly unless debugging the docs app itself.

On this page