docs: maintainer agent guidance that does not ship into generated brains
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 50/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- github, markdown
- Domain
- documentation, tooling
Research direction
Read brain-kit's AGENTS.md and inspect how this template copies root and .github files. Use the stated gh repo create command to generate a scratch repository, list its files, and run brain-kit's leakage gate. Done means the chosen maintainer guidance location is documented here, absent from the generated repository, and names the three repositories and canonical AGENTS.md.
Written by the indexing model from the issue text.
Description
Context
The three open-source repositories now have one canonical statement of how they relate. It is the "The five repositories" section of brain-kit's AGENTS.md, added in schlessera/brain-kit#296:
brain-kitis the engine.brain-templateis the starting point for your own second-brain repo.brain-hosting-templateis the starting point for your own hosted PWA that manages that brain remotely.
All three share the public brain-kit roadmap board. Private instances generated from the templates consume the public project, and the public project never references them.
This repository has no agent guidance for its own maintainers. There is a catch: the files at the root of a template are copied into every repository generated from it. Here that includes CLAUDE.md, which is the generated brain's own instructions file. Maintainer guidance put there would ship to every user. That makes this a decision about where the guidance goes, not just a missing file.
Maintainer decision — 2026-10-01
Option A: use the central brain-kit maintainer guidance and explicitly load it for template-maintenance sessions. Use brain-kit's AGENTS.md as the canonical policy and docs/process/github.md as the tracker/roadmap working agreement. Keep this guidance outside generated-brain files.
The editable template source is brain-kit's template/; scripts/publish-template.ts generates the standalone repository. Its existing README-template-dev.md exclusion is retained. That note may point to the central guidance without maintaining a second policy; generated-brain CLAUDE.md remains user guidance.
Scope
- Use the central brain-kit guidance as the maintained entry point for agents working on the template source; sessions explicitly read it before changes.
- Ensure that entry point identifies the three public repositories and their roles, the one-way reference rule and shared public roadmap, linking the canonical AGENTS.md rather than duplicating its policy. Any necessary central clarification belongs in brain-kit.
- Verify that a repository generated from the published template contains none of this maintainer-only guidance. Preserve the generated brain's user instructions and existing publisher exclusion.
Out of scope
- Changing what a generated repository contains, apart from keeping this guidance out of it.
- Anything about a specific deployment or instance.
Acceptance criteria
- A written decision on the location, in a comment here, with the reason: option A selected on 2026-10-01.
- A repository generated from this template contains none of the maintainer guidance, shown by generating one and listing its files.
- The central brain-kit guidance identifies the three public repositories, the one-way reference rule and public roadmap, links the canonical
AGENTS.md, and is explicitly loaded for template maintenance. - The text passes brain-kit's leakage gate.
Verification
gh repo create <scratch> --template schlessera/brain-template --private --clone
# confirm the maintainer guidance is absent, then delete the scratch repo
Contract impact
- None.
Updated 2026-10-01: folded the maintainer's option A ruling into scope and acceptance criteria, with the verified source/publisher boundary. Guidance and generated-file verification remain open; the location decision is complete.
- Dominant language
- TypeScript
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from schlessera/brain-template
-
agent-ready area: config area: skills type: chore upstream: brain-kit
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
area: config priority: p2 type: feat
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
schlessera/brain-template#3 · 1 comment ·
-
Generated brain depends on the Agent SDK, so brain sync finds Claude Code without a host installOpenarea: config priority: p2 type: feat
Difficulty 3/5 1-2 days Newbie friendliness 72/100
All issues in schlessera/brain-template
Similar issues
-
[Bug]: Server git tests sign fixture commits with the developer's key when run from the repo rootOpen
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
melgarafael/DeskcommCRM#2657 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
MystenLabs/MemWal#1163 · 2 comments ·
Maintainers usually reply within 1 day
-
Mondriaan
Difficulty 1/5 Under an hour Newbie friendliness 88/100
knaw-huc/textannoviz#709 ·
Maintainers usually reply within 1 day
-
billion-context-pi
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
ranxianglei/billion-context#2521 · 3 comments ·
Maintainers usually reply within 1 day