The snapshot config field (added in 28a4517) is undocumented. It lacks both a section in the config docs page (packages/web/src/content/docs/config.mdx) and a .describe() annotation on its schema definition.
Users frequently discover the hard way that snapshots can consume enormous disk space in large repos, with no obvious way to disable them. Multiple issues reference this:
A prior PR (#4753) attempted to add this documentation but was closed without merge.
What should be documented
- A
.describe() annotation on the snapshot schema field in config.ts
- A "Snapshot" section in
config.mdx explaining:
- What snapshots do (track file changes, enable undo/revert)
- How to disable them (
"snapshot": false)
- The tradeoff: disabling means session undo/revert becomes unavailable
- When you might want to disable: large repos, many submodules, disk space concerns
The
snapshotconfig field (added in 28a4517) is undocumented. It lacks both a section in the config docs page (packages/web/src/content/docs/config.mdx) and a.describe()annotation on its schema definition.Users frequently discover the hard way that snapshots can consume enormous disk space in large repos, with no obvious way to disable them. Multiple issues reference this:
A prior PR (#4753) attempted to add this documentation but was closed without merge.
What should be documented
.describe()annotation on thesnapshotschema field inconfig.tsconfig.mdxexplaining:"snapshot": false)