Files
CodeWhale Bot aecf3b07d7 docs: align repository guidance with extracted Engine and Next [skip ci]
Finish inherited guidance changes: point the existing sole prompt, turn-loop and remember references at the extracted Engine. Preserve the Next.js guidance generated by the installed version rather than leaving its ordinary dev-server write dirty.

Verified all three Engine paths exist and the complete generated Next block matches the unescaped template in web/node_modules/next/dist/server/lib/generate-agent-files.js; git diff --check passed. Documentation only; no tests or builds repeated. Root CW operator controls were not copied.
2026-11-01 22:46:50 -08:00

2.6 KiB

Web agent guidance

Read the repository guidance first. This directory is the Codewhale Next.js site.

  • Repository facts are generated by npm run prebuild into lib/facts.generated.ts. Change their source and regenerate; never hand-edit the generated file.
  • lib/changelog.generated.ts, lib/release-notes.generated.ts and lib/install-guide.generated.ts are not tracked. npm run prebuild, npm run dev and the vitest global setup derive them from CHANGELOG.md and docs/INSTALL.md; never commit them.
  • Shared public copy lives in lib/content/. Keep product vocabulary aligned with docs/public-surface-facts.json and docs/MODES.md; extend locale data, not individual pages.
  • Localization migrations are one-way. New or touched pages use the shared dictionary/content spine; do not add page-local language booleans, isZh copy forks, or hard-coded translated page clones. A compatibility exception must name the external contract that still requires it. Website/docs machine translation uses npm run i18n:gt (local JSON catalogs into the same dictionaries). Do not add gt-next beside that path, and do not point GT at TUI locale packs.
  • Real-session media is owned by lib/media-manifest.ts. pending is the truthful state until the complete asset set passes manifest tests.
  • AGENT.md (singular) documents maintainer-owned community automation. Do not expand its authority without Hunter.

Choose evidence according to the claim. For a localized page, render and inspect that page at representative widths and run the narrow dictionary/content check if it adds useful confidence. For a build-system or release-wide change, a full gate may be justified. Do not run this whole sequence by default, and do not add a test merely to freeze copy or component structure:

npm ci
npm run prebuild
npm run check:facts
npm run check:docs
npm test
npm run lint
npm run build

This is NOT the Next.js you know

This version has breaking changes — APIs, conventions, and file structure may all differ from your training data. Read the relevant guide in node_modules/next/dist/docs/ (resolved from this file's directory; in monorepos the next package may not be visible from the repo root) before writing any code. Heed deprecation notices.

This block is written and re-added by next dev — verify at node_modules/next/dist/server/lib/generate-agent-files.js. Removing it from a diff only re-creates the uncommitted change; committing it with your work keeps the tree clean.