docs: add describe annotation to snapshot config field#17861
Merged
rekram1-node merged 4 commits intoanomalyco:devfrom Mar 17, 2026
Merged
docs: add describe annotation to snapshot config field#17861rekram1-node merged 4 commits intoanomalyco:devfrom
rekram1-node merged 4 commits intoanomalyco:devfrom
Conversation
github-actions
bot
added
needs:compliance
github-actions
bot
removed
the
needs:compliance
Contributor
|
Thanks for updating your PR! It now meets our contributing guidelines. 👍 |
Clarified note about disabling snapshots and rollback.
ConanXu-math
pushed a commit
to ConanXu-math/opencode
that referenced
this pull request
Mar 17, 2026
Co-authored-by: Aiden Cline <63023139+rekram1-node@users.noreply.github.com>
This was referenced Mar 18, 2026
AvatarGanymede
pushed a commit
to AvatarGanymede/opencode-dev
that referenced
this pull request
Mar 19, 2026
Co-authored-by: Aiden Cline <63023139+rekram1-node@users.noreply.github.com>
demostanis
pushed a commit
to demostanis/opencode
that referenced
this pull request
Mar 19, 2026
Co-authored-by: Aiden Cline <63023139+rekram1-node@users.noreply.github.com>
demostanis
pushed a commit
to demostanis/opencode
that referenced
this pull request
Mar 20, 2026
Co-authored-by: Aiden Cline <63023139+rekram1-node@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue for this PR
Closes #17863
Related: #4753 (prior attempt), #10626, #6845, #3182, #17753, #16336 (users struggling with snapshot disk usage)
Type of change
What does this PR do?
The
snapshotconfig field was added in 28a4517 but was never documented. This PR:.describe()annotation to thesnapshotschema field inconfig.ts, matching the pattern used by other config fields.config.mdxexplaining what snapshots do, how to disable them, and the tradeoff (no undo/revert when disabled). Placed between Keybinds and Autoupdate sections.How did you verify your code works?
Read the schema definition and confirmed the
.describe()follows the same chaining pattern as adjacent fields. Verified the config.mdx section renders consistently with surrounding sections.Checklist