Skip to content
Colour intensity

Agents and validation

The root AGENTS.md is the single authored project instruction source. It covers architecture, branding, accessibility, generated output, secrets and change review. Instructions guide agents; CI and platform permissions enforce controls.

Agent Entry point Shared workflow
GitHub Copilot .github/copilot-instructions.md points to AGENTS.md .github/skills/validate-build/SKILL.md
Claude Code Root CLAUDE.md imports @AGENTS.md Read the same skill explicitly
Codex / ChatGPT Root AGENTS.md Read the same skill explicitly

Different products have different native skill-discovery rules. Do not assume universal automatic discovery or duplicate the skill into three authored directories. Use an explicit path when needed.

Scoped checks

  • Website or shared theme: npm run validate:web. This lints, then runs TypeScript and Vite once through the workspace build.
  • Documentation: from /docs, python scripts/build.py validate with the docs environment active. This verifies source checksums, copies assets and runs strict MkDocs.
  • Shared brand source: run both website and docs checks, then the brand browser smoke check described below.
  • Optional Worker: npm run deploy --workspace=@cwtch/api -- --dry-run.
  • Isolated Panda alternative: npm ci and npm run typecheck && npm run build from alternatives/ark-panda. Its scripts generate Panda CSS and copy the canonical assets.

Both synchronisers reject missing files and checksum mismatches. To intentionally replace an approved asset, update its source and the reviewed manifest together. Builds never rewrite the source manifest. Do not commit generated public copies, dist, site, environments, .wrangler or credentials.

Browser validation

After building the website and docs, run npm run test:brand. The Playwright check starts local static servers, verifies loaded fonts, PNG/WebP logo variants, favicons, the exact palettes, persistence, keyboard controls and narrow-screen overflow. Install Chromium with npx playwright install chromium on a new machine. This test is a focused integration check, not an accessibility certification.

Writing guidance

Use British English and preserve Welsh diacritics. Arvo Bold does not include ŵ/ŷ in the supplied release. Use Lexend 700 for the whole affected Welsh heading. Describe Cwtch as an independent project umbrella; do not invent company status, services or clients.