Skip to content

docs: document snapshot config option #17862

Description

@altendky

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

  1. A .describe() annotation on the snapshot schema field in config.ts
  2. 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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

docsneeds:complianceThis means the issue will auto-close after 2 hours.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions