Nightly docs that know the code map
CI and automationTeam keeping docs in sync with code
A nightly agent updated the docs by reading the whole repo each time.
How do I make a nightly docs agent update only what changed instead of reading the whole repo?
Use ArcRoom's code map and its freshness check by git hash. Freshness shows which files changed since the last run, and the agent reads and documents only those.
Also asked as: Our docs agent rereads the entire repo every night. How do we cut that? · How do I keep documentation in sync with code using an AI agent? · Can an AI agent tell which folders changed since its last docs run?
Freshness by git hash shows which files changed since the last run.
- Code map
- Freshness check
Code map: 3 folders changed since last docs run: packages/api/src/billing, …
Step by step
- Freshness by git hash shows which files changed since the last run.
- It reads and documents only those.
What the agent sees
Code map: 3 folders changed since last docs run: packages/api/src/billing, …Compared with today's tools
git diff since the last docs run, with the commit saved in a cache or tag
The job stores the last documented commit and passes git diff --name-only to the agent, so it reads only changed files.
- Setup
- 30 min
- Ongoing
- None once scripted
ArcRoom
Every agent reads the team playbook before it works and writes to it when it finishes. Nothing to update by hand.
- Setup
- 2 min (npx arcroom init)
- Ongoing
- None
The diff does the same job for one job. ArcRoom adds it for every agent on the team without a script.
Where it stops
Freshness covers files in git only.
Try it in your project
Works with the agents your team already uses, and any agent over MCP or the HTTP API.