docs(agents): track all AGENTS.md guides and refresh review instructions#4969
Merged
Conversation
Force-add every AGENTS.md in the repository (root, directory-level, and all 31 crate guides) so coding/review agents pick up path-specific instructions from version control instead of local-only files. These were previously untracked because AGENTS.md is globally ignored. Add the seven previously missing crate guides: zeph-agent-context, zeph-agent-feedback, zeph-agent-persistence, zeph-agent-tools, zeph-durable, zeph-plugins, and zeph-worktree, matching the existing per-crate format with crate-local checks, invariants, gates, and spec references. Refresh .github/copilot-instructions.md: correct the crate count, fix the feature-gated crate list, and document the agent-pipeline and zeph-durable dependency invariants.
github-actions
Bot
added
documentation
Add a !AGENTS.md negation so per-directory agent guides are tracked despite the contributor's global AGENTS.md ignore, preventing new guides from being silently skipped.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
AGENTS.mdis listed in the global gitignore, so everyAGENTS.mdin this repository was a local-only, untracked file. Coding and review agents (Copilot CLI, Codex, etc.) that rely on path-specificAGENTS.mdinstructions were getting them only on the author's machine, never from version control. On top of that, seven crates had noAGENTS.mdat all, and the repo-wide review instructions were stale.Changes
AGENTS.md(force-added past the global ignore): the root guide, 7 directory-level guides (crates/,src/,tests/,docker/,config/,book/,.github/), and all 31 crate guides. They are now under version control so agents pick them up everywhere.zeph-agent-context,zeph-agent-feedback,zeph-agent-persistence,zeph-agent-tools,zeph-durable,zeph-plugins,zeph-worktree— matching the existing per-crate format: crate-localbuild/nextest/clippychecks, hard invariants, LLM-serialization/security gates, multi-model notes, andspecs/references..github/copilot-instructions.md: correct the crate count (10 → 31 library crates + thezephCLI binary), fix the feature-gated crate list, and document the agent-pipeline (zeph-agent-*must not depend onzeph-core) andzeph-durableLayer-0 dependency invariants.Each new crate guide cites its spec: 021-zeph-context, 016-agent-feedback, 057-agent-persistence, 006-tools, 064-durable-execution, 058-plugins, 063-worktree-subsystem.
Test evidence
Documentation-only change — no Rust sources touched, so the
fmt/clippy/nextestbuild gate is not applicable. Verified that every crate now has a guide (31/31) and that the architecture invariants in the guides match the actual workspace dependency directions andspecs/contents.Notes
AGENTS.mdremains in the global gitignore, so future guides in new crates will be silently ignored again. A repo-level.gitignorenegation (!AGENTS.md) can be added in a follow-up to keep them tracked automatically.