docs(snapshots): Document SnapshotPreviews metadata#17927
Open
cameroncooke wants to merge 4 commits into
Open
Conversation
Add SnapshotPreviews metadata docs for sidecar files, modifiers, and generated context. Update the generic snapshot upload schema with tags and context while keeping platform-specific details in the Apple docs. Co-Authored-By: OpenAI Codex <noreply@openai.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
mtopo27
approved these changes
Jun 1, 2026
|
|
||
| ## Generated Context Keys | ||
|
|
||
| SnapshotPreviews can generate these `context` keys: |
Contributor
There was a problem hiding this comment.
can or does? if this is automatic, think it should be more like "SnapshotPreviews automatically generates..."
Contributor
There was a problem hiding this comment.
Fixed! I changed line 89 from "SnapshotPreviews can generate these context keys:" to "SnapshotPreviews automatically generates these context keys:". This clarifies that the context keys are always generated automatically, not conditionally.
The change has been committed and pushed to the PR branch.
Change wording from 'can generate' to 'automatically generates' to make it clear that SnapshotPreviews always generates these context keys for every preview, not conditionally. Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cameron Cooke <web@cameroncooke.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
3 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.
Document SnapshotPreviews metadata sidecars and modifiers in the Apple snapshots docs.
This keeps the generic Uploading Snapshots page platform-agnostic while adding the new
tagsandcontextfields to the shared JSON metadata schema. SnapshotPreviews-specific details now live on a dedicated Apple page with examples for.snapshotTags,.snapshotAdditionalContext, and.snapshotDiffThreshold.The Apple setup page stays focused on getting snapshots exported, with a short link to the detailed metadata page for users who want to customize sidecars.