Skip to content

AGENTS.md

Latest commit

 

History

History
33 lines (25 loc) · 1.27 KB

AGENTS.md

File metadata and controls

33 lines (25 loc) · 1.27 KB
Raw

Repository Engineering Guide

Source Of Truth

  • Edit numbered Markdown chapters under docs/core/, docs/tools/, docs/guides/, and docs/reference/.
  • scripts/handbook-manifest.txt is the only publication-order manifest.
  • Never edit dist/AI_CODING_ENGINEERING_HANDBOOK.md directly; regenerate it.
  • Keep docs/ reader-facing; do not add internal process records or temporary planning artifacts there.

Content Boundaries

  • Keep tool-independent guidance in docs/core/.
  • Keep Codex and Claude Code behavior in their respective docs/tools/ directories.
  • Do not add product claims without a current official HTTPS source or repository evidence.
  • Preserve user changes and keep edits scoped to the requested handbook area.

Commands

bash scripts/build-handbook.sh
bash -n scripts/build-handbook.sh
bash -n scripts/check-handbook.sh
bash -n tests/check-handbook-test.sh
bash tests/check-handbook-test.sh
bash scripts/check-handbook.sh

Definition Of Done

  • The generated handbook matches its source chapters.
  • Internal links, anchors, code fences, headings, and manifest coverage pass checks.
  • Product-specific content has not leaked into generic chapters without a justified cross-link.
  • Validation results and any unverified risks are reported accurately.