Repository navigation
[External State] Docs and implementation diverge on gitignore behavior #1400
Description
Summary
Docs and implementation diverge on .gitignore behavior for externalize/internalize.
Evidence
- Docs say externalize adds
.squad/to.gitignore:docs/src/content/docs/features/external-state.md:103
- Docs say internalize removes
.squad/from.gitignore:docs/src/content/docs/features/external-state.md:124
- Implementation appends only
.squad/config.jsonignore block:packages/squad-cli/src/cli/commands/externalize.ts:217-229
runInternalize(...)has no gitignore cleanup:packages/squad-cli/src/cli/commands/externalize.ts:169-198
Expected
Either code and docs agree on full behavior, or docs are corrected to match actual behavior.
Actual
Current docs and code describe different ignore semantics.
Activity
bradygaster commentedon Jun 30, 2026
Fixed in PR #1426 (docs overhaul). Will auto-close on merge.
dat-intellis commentedon Jul 12, 2026
Would it not make more sense to either A) correct the gitignore file after internalizing state? Or B) at least write a note for the user to edit it accordingly?
docs: align external-state page with actual externalize/internalize b…
chore: promote dev -> main (v0.12.0) (#1698)