📖 [Docs]: Canonical memory repository template added#70
Merged
Marius Storhaug (MariusStorhaug) merged 2 commits intoJul 25, 2026
Conversation
Defines the concrete, copy-pasteable scaffold every organization's memory repository instantiates (README, CONTRIBUTING, index.md, gotchas/, knowledge/, agents/), maps each section back to what design.md already says memory owns, and documents the deliberate Repository Standard exception (no LICENSE/SECURITY.md/SUPPORT.md/ CODE_OF_CONDUCT.md/dependabot/CODEOWNERS/PR template) plus the private-by-default visibility. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
4 tasks
Marius Storhaug (MariusStorhaug)
marked this pull request as ready for review
July 25, 2026 14:52
Marius Storhaug (MariusStorhaug)
added a commit
that referenced
this pull request
Jul 25, 2026
## 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>
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.
The Agentic Development framework's design already names
MSXOrg/memoryandPSModule/memoryin its organization anatomy table, but neitherdesign.mdnorspec.mddefined a concrete file layout for amemoryrepository — only an illustrative list of folders. Anyone adopting the framework had nothing copy-pasteable to start from.New: Memory Repository Template
A new page, Memory Repository Template, defines the exact scaffold every organization's
memoryrepository instantiates:README.md,CONTRIBUTING.md,.gitattributes,.gitignore, an OKF-styleindex.md, andgotchas/,knowledge/(with a lazily-createdrepos/subfolder), andagents/sections. Content differs per organization; structure does not.The page also documents, explicitly, that a
memoryrepository is a deliberate exception to the Repository Standard's default file set — noLICENSE,SECURITY.md,SUPPORT.md,CODE_OF_CONDUCT.md,.github/dependabot.yml,.github/CODEOWNERS, or.github/pull_request_template.md— because it is a private, no-PR-workflow, dependency-free working-memory store rather than a public collaborative product. Default visibility is stated as private.spec.mdanddesign.mdnow link to the new page, anddesign.md's adoption path points to it as the starting scaffold for step 2.Technical Details
src/docs/Frameworks/Agentic-Development/memory-template.md.src/zensical.tomlnav under Frameworks → Agentic Development;Frameworks/Agentic-Development/index.mdregenerated viaUpdate-DocumentationIndex.ps1.spec.mdanddesign.md"Where this connects" sections, and fromdesign.md's adoption path.Test-DocumentationLink.ps1andmarkdownlint(using.github/linters/.markdown-lint.yml) both pass clean on the changed files.MSXOrg/memoryitself using this template.Related issues