Skip to content

Commit d929252

Browse files
πŸ“– [Docs]: AGENTS.md added to Memory Repository Template scaffold (#77)
## Why A sibling session auditing the live ecosystem found that both instantiated memory repos β€” `MSXOrg/memory` and `PSModule/memory` β€” were missing `AGENTS.md`, the cross-client agent entry point that [design.md's client behavior table](https://msxorg.github.io/docs/Frameworks/Agentic-Development/design/#client-behavior) says every repository in the framework carries: "Cross-client agents | `AGENTS.md` | Read the shared project pointer and local nuance." Tracing it back, the gap isn't just in those two repos β€” it's in the template they were scaffolded from. `memory-template.md` (introduced in #70) never listed `AGENTS.md` in its `## Scaffold` file tree, so any future memory repository instantiated from this template would launch missing it too. **Note:** `MSXOrg/memory` and `PSModule/memory` have already been fixed directly (their `AGENTS.md` files exist and work today). This PR doesn't need to land for those two repos to be correct β€” it's solely so future memory repositories get `AGENTS.md` from day one. ## What changed - Added `AGENTS.md` to the `## Scaffold` code-fence tree, right after `README.md`/`CONTRIBUTING.md`, with an inline comment describing its purpose. - Added a paragraph explaining that `AGENTS.md` doesn't map to a `memory` ownership bullet from `design.md#memory` β€” it's the framework's client-behavior-table entry point instead, distinct from `CONTRIBUTING.md`'s contribution-process framing even though this repo's real audience is agents. - Updated the "A memory repository still carries README.md, CONTRIBUTING.md, .gitattributes, and .gitignore" sentence in the Repository Standard exception section to include `AGENTS.md`. ## Validation - `.github/scripts/Test-DocumentationLink.ps1` β€” all links resolve. - `markdownlint-cli` against `.github/linters/.markdown-lint.yml` on the changed file β€” clean. - `.github/scripts/Update-DocumentationIndex.ps1 -Check` reports pre-existing drift across many unrelated index files on `main` (confirmed by stashing this change and re-running) β€” not caused by this PR, and this page's front matter (`title`/ `description`) is unchanged, so it adds no new drift. Follow-up to #70 (which introduced `memory-template.md`). Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 1a9849a commit d929252

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

β€Žsrc/docs/Frameworks/Agentic-Development/memory-template.mdβ€Ž

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ organization; structure does not.
1818
memory/
1919
β”œβ”€β”€ README.md # front door: what this repo is, that it's private, "commit straight to main, no PR"
2020
β”œβ”€β”€ CONTRIBUTING.md # short: direct push to main, no PR/review gate, keep entries short/dated/factual
21+
β”œβ”€β”€ AGENTS.md # cross-client agent entry point: orients an agent landing here cold, points at index.md and the memory-writing rules
2122
β”œβ”€β”€ .gitattributes
2223
β”œβ”€β”€ .gitignore
2324
β”œβ”€β”€ index.md # OKF root index (okf_version frontmatter), links to the sections below
@@ -48,6 +49,16 @@ top-level folder is one of those responsibilities made concrete:
4849
it links to `gotchas/index.md`, `knowledge/index.md`, and `agents/index.md` so a human or
4950
agent can start at the root and drill inward.
5051

52+
`AGENTS.md` doesn't map to a `memory` ownership bullet β€” it isn't content memory owns, it's the
53+
framework's [client behavior table](design.md#client-behavior) entry point: "Cross-client agents |
54+
`AGENTS.md` | Read the shared project pointer and local nuance." Every repository in the
55+
framework carries one so an agent landing cold knows where to start; a `memory` repository is no
56+
exception. Its job is narrower than `README.md`'s and different from `CONTRIBUTING.md`'s β€” it
57+
orients an *agent* specifically, pointing straight at `index.md` and the
58+
[memory writing rules](design.md#memory-writing-rules), while `CONTRIBUTING.md` stays
59+
contribution-process-flavored (direct push, no PR) even though this repository's real audience is
60+
agents, not human contributors.
61+
5162
## A deliberate exception to the Repository Standard
5263

5364
[Repository Standard](../../Ways-of-Working/Repository-Standard.md) lists the files every
@@ -75,8 +86,8 @@ exception, made explicit rather than left as an oversight:
7586
expectations for a broad or public contributor community; a `memory` repository's
7687
audience is the organization's own humans and agents.
7788

78-
A `memory` repository still carries `README.md`, `CONTRIBUTING.md`, `.gitattributes`, and
79-
`.gitignore` β€” the minimum needed to explain itself and behave predictably in git.
89+
A `memory` repository still carries `README.md`, `CONTRIBUTING.md`, `AGENTS.md`, `.gitattributes`,
90+
and `.gitignore` β€” the minimum needed to explain itself and behave predictably in git.
8091

8192
## Visibility
8293

0 commit comments

Comments
Β (0)