11# AGENTS.md
22
33Guidance for coding agents working in this repository. Keep changes consistent
4- with ` README.md ` and ` RELEASE.md ` ; those are the authoritative user-facing docs.
4+ with ` README.md ` and ` docs/ RELEASE.md` ; those are the authoritative user-facing docs.
55For terminal/curl workflows, ` site/public/llms.txt ` ,
66` site/public/llms-full.txt ` , and ` site/public/docs/index.md ` are the
77agent-readable docs entry points derived from the authoritative docs.
@@ -41,7 +41,7 @@ non-trivial.
4141
4242The public docs site also ships Markdown entry points for agent tooling under
4343` site/public/llms.txt ` , ` site/public/llms-full.txt ` , and ` site/public/docs/ ` .
44- Keep those files aligned with ` README.md ` , ` RELEASE.md ` , and user-visible site
44+ Keep those files aligned with ` README.md ` , ` docs/ RELEASE.md` , and user-visible site
4545navigation when docs structure changes.
4646
4747## A7 Source Rules
@@ -65,7 +65,7 @@ navigation when docs structure changes.
6565 or prefix ` * ` as reference operations; pass lvalues directly to ` ref `
6666 parameters and use ordinary field access after nil checks.
6767- Native release archives are named with platform/toolchain context
68- (` a7-example-artifacts-linux-x86_64-zig0.15.2 -<profile>.tar.gz ` ); keep
68+ (` a7-example-artifacts-linux-x86_64-zig0.16.0 -<profile>.tar.gz ` ); keep
6969 any docs or scripts that reference these filenames in sync.
7070- This rule applies to A7 source only. Compiler internals already use
7171 iterative AST traversals; keep them that way.
@@ -76,18 +76,17 @@ After making major changes (new language features, bug fixes, backend
7676additions, refactors), ensure the following docs are up to date before
7777committing:
7878
79- 1 . ** CHANGELOG.md** — add an entry for the change
79+ 1 . ** docs/ CHANGELOG.md** — add a short release-facing entry
80802 . ** README.md** — update usage, feature lists, or examples if affected
81813 . ** docs/SPEC.md** — update if language semantics or syntax changed
82- 4 . ** MISSING_FEATURES.md** — mark completed gaps or document new ones
83- 5 . ** TODO.md** — check off completed items or add newly discovered work
84- 6 . ** site/public/llms.txt** , ** site/public/llms-full.txt** , and
82+ 4 . ** docs/STATUS.md** — update current gaps, priorities, or roadmap
83+ 5 . ** site/public/llms.txt** , ** site/public/llms-full.txt** , and
8584 ** site/public/docs/** — update agent/curl.md entry points if site
8685 navigation, release commands, CLI behavior, or public docs structure
8786 changed
8887
8988Keep examples and docs aligned across ` README.md ` , ` docs/SPEC.md ` ,
90- ` CHANGELOG.md ` , ` MISSING_FEATURES.md ` , ` TODO .md` , ` site/public/llms.txt ` ,
89+ ` docs/ CHANGELOG.md` , ` docs/STATUS .md` , ` site/public/llms.txt ` ,
9190` site/public/llms-full.txt ` , and ` site/public/docs/ ` — drift between them is
9291treated as a bug.
9392
0 commit comments