OUI_XFAB documentation

Verification and Operations

Local Quality Gates

Run the gates appropriate to the change risk:

npm ci
npm run validate:dependencies
npm run validate:env
npm run validate:workflows
npm run lint
npm run type-check
npm run test:coverage
npm run build
npm run docs:build
npm run test:e2e

For dependency changes, also run both npm audit --omit=dev and the full npm audit. For protocol, lifecycle, architecture, or release changes, include focused regression tests and the relevant contract suites.

Documentation Publication

npm run docs:build renders the hosted Markdown with Eleventy and copies the checked Archify artifact, stylesheet, and UI migration PNG evidence into dist/docs. npm run docs:deploy rebuilds that directory and uploads it to the dedicated oui-xfab-docs Cloudflare Pages project as its master deployment.

The release operator must be authenticated to the intended Cloudflare account and have Pages write access. After upload, verify public HTTP 200 responses for the home page, architecture guide, standalone diagram, UI migration tracker, and representative screenshot assets. Also verify that the pages load /assets/docs.css without a 404. The xfaboui application project is outside this documentation release scope.

Current Evidence

The canonical TypeScript 6 migration was validated in a clean checkout with 132 test files and 1,291 tests passing, production build passing, strict type-check passing, lint passing, browser E2E passing, and both audit modes reporting zero vulnerabilities.

The Archify runtime diagram passed all nine showcase artifact checks with zero composition errors and warnings. Its visual containment check passed at 1440x900, 1600x1000, 1920x1080, and 2048x1320 in light and dark themes.

Browser Review

The production-preview Playwright suite is the authoritative browser smoke path. Use the deterministic WebSocket mock in tests/e2e/support/eapWebSocketMock.ts for UI fixture capture. Do not treat a screenshot taken against a live EAP backend as a reproducible baseline.

Failure Triage

• A failed npm ci is a dependency or registry/environment issue until the lockfile is checked.
• A type-check failure belongs first to TypeScript, vue-tsc, or a source contract; do not weaken compiler settings.
• A browser failure must distinguish application behavior, WebSocket fixture setup, browser installation, and environment reachability.
• A staging deployment failure must distinguish SSH/sudo, proxy configuration, EAP reachability, artifact activation, and post-deploy checks. The deployment script must restore the previous symlink on failed checks.

Evidence Retention

Keep screenshot pairs, test fixtures, Archify specifications, delivery receipts, and release logs with the change that produced them. Do not overwrite historical baselines to make a later UI look equivalent; create a new review pair when the behavior or visual contract changes.