Skip to content

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Agent-Maintained Wiki — sample repo

A small CRM codebase that demonstrates the agent-maintained wiki pattern: project knowledge lives in the repo as small markdown pages, and your coding agent reads the relevant ones before a change and updates them after.

Read the write-up: The Wiki That Never Goes Stale

What's inside

.
├── CLAUDE.md                      router: always loaded — code map, docs index, standing rules
├── AGENTS.md                      points other coding agents at CLAUDE.md
├── docs/                          the wiki: one OKF page per topic
├── prompts/
│   ├── bootstrap.md               one-time prompt that generates the wiki for your repo
│   └── standing-rules.md          rules to paste into your own CLAUDE.md
├── src/                           sample CRM: contacts, deals, pipeline
├── tests/                         node:test specs, one file per module
└── .github/
    ├── pull_request_template.md   docs checklist on every PR
    └── workflows/ci.yml           runs tests; fails PRs that change src/ without docs/

Try it

Requires Node 24+. TypeScript runs directly — no build step, no dependencies.

git clone https://github.com/infonex/agent-maintained-wiki.git
cd agent-maintained-wiki
npm test

Then open your coding agent in the folder and ask:

Can a deal skip from lead to proposal?

It should answer from docs/pipeline.md without reading the whole codebase. Next, ask it to add a negotiation stage after proposal, and check that docs/pipeline.md and docs/gotchas.md change alongside the code.

Use it in your own repo

  1. Bootstrap. Open your agent at the repo root, fill in the placeholders in prompts/bootstrap.md, and paste it. Review the generated pages as a team.
  2. Add the rules. Copy prompts/standing-rules.md into your CLAUDE.md.
  3. Wire the gate. Copy the PR template and the docs job from ci.yml, then create a docs-not-needed label for PRs with no docs impact.

Page format

Every page follows Google Cloud's Open Knowledge Format (OKF): plain markdown with a YAML header. OKF requires only type; module, updated and status help the agent pick the right pages and judge how fresh they are.

---
type: concept
module: deals
updated: 2026-09-14
status: current
---

# Deals

Credits

Builds on Andrej Karpathy's LLM Wiki pattern and Google Cloud's Open Knowledge Format.

License

MIT

About

Sample repo: a documentation wiki your coding agent reads and maintains (CLAUDE.md router + Open Knowledge Format pages)

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages