docs: remove outdated Sanity Studio major version branding - #1930
Open
stipsan wants to merge 1 commit into
Open
Conversation
Reword READMEs, package descriptions, and agent guidance to be version-agnostic so docs do not go stale when Studio majors advance. Keep historical CHANGELOG entries and intentional legacy v2 notes.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
🦋 Changeset detectedLatest commit: e0a03d9 The changes in this PR will be included in the next version bump. This PR includes changesets to release 7 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
✅ E2E Tests🟢 26 passed • view full report • view run Studio: https://plugins-e2e-test-studio-n9frunezd.sanity.dev Datasets: |
Coverage Report
File Coverage
|
||||||||||||||||||||||||||||||||||||||
stipsan
marked this pull request as ready for review
August 20, 2026 10:28
stipsan
requested review from
a team and
pedrobonamin
and
a lite review from Copilot
and removed request for
a team
August 20, 2026 10:28
Contributor
There was a problem hiding this comment.
Pull request overview
This PR removes consumer-facing references to specific Sanity Studio major versions (eg “Studio v3/v5+”) across plugin READMEs, package descriptions, and plugin-kit verification messaging to keep documentation version-agnostic over time.
Changes:
- Updated multiple plugin READMEs/docs to remove major-pinned Studio wording while keeping legacy v2 notes where helpful.
- Adjusted npm package descriptions for
sanity-plugin-mediaandsanity-plugin-utils. - Reworded
@sanity/plugin-kitESM-only verification message + docs and updated the corresponding snapshot.
Reviewed changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| plugins/sanity-plugin-workflow/README.md | Removes “Studio v2” branding in a section heading/body. |
| plugins/sanity-plugin-utils/package.json | Makes package description version-agnostic. |
| plugins/sanity-plugin-studio-smartling/README.md | Reframes migration section away from “Studio v3” and updates related links/wording. |
| plugins/sanity-plugin-media/README.md | Removes “for Studio v3” branding and keeps a legacy v2 branch note. |
| plugins/sanity-plugin-media/package.json | Replaces major-pinned description with a general product description. |
| plugins/sanity-naive-html-serializer/README.md | Renames “v2-to-v3” section to a version-agnostic “Schema access changes”. |
| plugins/@sanity/vercel-protection-bypass/README.md | Removes Studio-major requirement line from the IMPORTANT callout. |
| plugins/@sanity/orderable-document-list/README.md | Rewords a “Breaking change in v3” note to a version-agnostic configuration note. |
| plugins/@sanity/language-filter/README.md | Renames “Changes in V3” heading to “Schema options”. |
| plugins/@sanity/document-internationalization/docs/00-upgrade-from-v1.md | Makes upgrade guidance less Studio-major specific while keeping legacy v2 branch guidance. |
| plugins/@sanity/cross-dataset-duplicator/README.md | Removes “Studio v3” from image alt text. |
| packages/@sanity/plugin-kit/test/snapshots/verify-package.test.ts.snap | Updates snapshot for ESM-only validation message wording. |
| packages/@sanity/plugin-kit/src/actions/verify/validations.ts | Makes ESM-only validation wording version-agnostic. |
| packages/@sanity/plugin-kit/README.md | Updates docs wording for esmOnly guidance to remove major pinning. |
| CONTRIBUTING.md | Rewords Studio baseline bullet to avoid naming a specific major. |
| .changeset/utils-description.md | Patch changeset for sanity-plugin-utils description wording. |
| .changeset/plugin-kit-esm-message.md | Patch changeset for @sanity/plugin-kit ESM verify message wording. |
| .changeset/media-description.md | Patch changeset for sanity-plugin-media description wording. |
| .agents/skills/plugin-transfer/SKILL.md | Updates transfer-skill guidance/examples to avoid pinning Studio majors. |
Suppressed comments (1)
packages/@sanity/plugin-kit/src/actions/verify/validations.ts:221
- The phrase “Sanity Studio, which is pure ESM” reads like it applies to all Studio versions. To avoid misleading consumers while staying version-agnostic, consider wording this as “supported Sanity Studio versions are pure ESM”.
package.json ships CommonJS (CJS) output, but Sanity plugins target Sanity Studio, which is pure ESM.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+192
to
+193
| * Bans CommonJS interop in package.json. The plugin baseline is Sanity Studio, | ||
| * which is pure ESM, so there is no reason to publish a parallel CJS build anymore. This flags: |
Comment on lines
+473
to
474
| `main`/`module` fields). This is discouraged: plugins target Sanity Studio, which is pure ESM, and | ||
| shipping a parallel CJS build can have unintended side-effects. The supported Node.js versions handle |
| ---------------------------------------------------------- | ||
| [error] | ||
| package.json ships CommonJS (CJS) output, but Sanity plugins target Sanity Studio v5+, which is pure ESM. | ||
| package.json ships CommonJS (CJS) output, but Sanity plugins target Sanity Studio, which is pure ESM. |
Comment on lines
6
to
+7
| > [!IMPORTANT] | ||
| > This plugin requires React 19.2 or later, and Sanity Studio v4. | ||
| > This plugin requires React 19.2 or later. |
| Serialized files are identical for both formats (items are identified by their language code), and `BaseDocumentMerger.internationalizedArrayMerge` writes patches in whichever format the target document already uses, preserving existing item keys when replacing. | ||
|
|
||
| ## v2-to-v3-changes | ||
| ## Schema access changes |
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
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.
Summary
Removes consumer-facing “Sanity Studio v3” (and similar major-pinned) wording from READMEs, package descriptions, and agent guidance so docs stay version-agnostic as Studio majors advance.
Changes
sanity-plugin-mediaandsanity-plugin-utils@sanity/plugin-kitESM-only verify messaging version-agnosticCHANGELOG.mdentries untouchedTesting
@sanity/plugin-kitverify-packageVitest suite passed (snapshot updated)