Add read-contract AGENTS.md; point organism prose at ORGANISM.md#15
Merged
Conversation
AGENTS.md defines how agents consult Memory: pull-only on demand (never automatic), index-first then at most 2-3 pages, never bulk-load; the Memory-vs-Mind split (what the science says vs what the organism did); and the personal-repo rule (no references from public repos). README's organism table becomes a pointer to the canonical PyAutoBrain/ORGANISM.md. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds agent-facing documentation clarifying how to consume PyAutoMemory and updates the README’s “organism” section to point to the canonical organism definition in PyAutoBrain.
Changes:
- Add
AGENTS.mddocumenting the “read contract” (pull-only, index-first, limited-page reading) and what does/doesn’t belong in this repo. - Replace the README’s organism organ-table with a short pointer to
PyAutoBrain/ORGANISM.mdandAGENTS.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Replaces organism table with a short description and pointers to canonical organism definition + agent guidance. |
| AGENTS.md | Introduces explicit agent guidance/read contract and repo boundaries (Memory vs Mind/Heart/Build). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+31
to
+33
| organism has learned. The organs and their boundaries are defined once in | ||
| `PyAutoBrain/ORGANISM.md`; how agents should read this repo is defined in | ||
| [`AGENTS.md`](AGENTS.md). |
Comment on lines
+5
to
+6
| bibliographies. (The organs and boundaries are defined once in | ||
| `PyAutoBrain/ORGANISM.md`.) |
Comment on lines
+17
to
+19
| 1. **Index first.** Start at [`index.md`](index.md), then the relevant | ||
| sub-wiki's own `index.md` (`lensing_wiki/`, `smbh_wiki/`, `cti_wiki/`, | ||
| `methods_wiki/`, `galaxies_wiki/`). |
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
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.
Roadmap items 5 + 10:
AGENTS.md(new) — the read contract: Memory is pull-only and on-demand (no automatic queries); index-first, then ≤2–3 pages, never bulk-load; Memory = what the science says, Mind = what the organism did (operational history lives incomplete.md/issues); personal-repo rule made explicit.PyAutoBrain/ORGANISM.md(Canonical ORGANISM.md; dedupe boundary prose; metaphor diet PyAutoBrain#25).🤖 Generated with Claude Code