Skip to content

Commit d936eae

Browse files
committed
Document private overlay refresh behavior
Fixes #403
1 parent 1708450 commit d936eae

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

AGENTS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,13 @@ git clone git@github.com:pixelgrade/anima-private.git /path/to/anima-private
4242
bin/bootstrap-private --source-dir /path/to/anima-private
4343
```
4444

45+
How later private-overlay changes are handled:
46+
- `bin/bootstrap-private` only manages these top-level targets: `AGENTS.local.md`, `.ai/`, `.claude/napkin.md`, and `.env.local`.
47+
- In the default copy mode, rerun `bin/bootstrap-private --force` when one of those targets changed in the private repo and you want to replace your local copy.
48+
- New files added inside `.ai/` are treated as part of the `.ai/` target, so copy mode still needs `--force` to refresh that directory.
49+
- If you bootstrap with `--link`, later changes inside the private repo show up through the symlink without recopies.
50+
- If you introduce a brand-new private path outside those managed targets, update `bin/bootstrap-private`, `.gitignore`, and `.zipignore` before expecting it to sync.
51+
4552
## Critical Warnings
4653

4754
- **Node 22+ required** (`.nvmrc` = 22, `package.json` engines `>=22.0.0`). Enforced by `node-tasks/lock_node_version.js` on `npm install`.

0 commit comments

Comments
 (0)