docs(readme): polish for public release#63
Merged
Conversation
Restructure and tighten the root README for publication while keeping every existing piece of accurate technical content. What changed: - Stronger lead: one-line tagline + a row of shields.io badges for Next, React, Sanity, TypeScript, Tailwind, Biome, license. No emoji. - New "Two flavours" section right under the lead — surfaces the variant/document-level branch and links to PR #62 (the permanent side-by-side comparison and decision guide). - "What you get" reflows the previous dense bullet sprawl into themed paragraphs (Next.js app, Studio, Media, Revalidation, SEO, Hardened defaults, Typed GROQ, Tailwind v4). Each block reads like a feature card, not a checklist. - Quickstart split into clean steps instead of one bash block with inline numbered comments. - "Architecture in brief" replaces the long "Core APIs & modules" tables; depth moves into the per-folder READMEs (already linked). - New "License" footer; the "Requirements" block moves to the bottom where it belongs (you don't read it before you're sold on the repo). - Fixed an orphan link to `packages/sanity-dataset-resolve/README.md` (file doesn't exist; resolver is documented inline in `src/index.ts`). - The strip-readmes utility gets one explicit mention so consumers know the documentation density is opt-in. Net result: 271 → 213 lines, 0 emoji, all links resolve. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
damianrosellen1
added a commit
that referenced
this pull request
May 28, 2026
Rolls out the public-release README from #63 to this branch, adapting the branch-specific sections for document-level i18n: - "Two flavours" table marks this branch as the current one - Studio description points at the Translations toolbar (@sanity/document-internationalization) instead of per-field language tabs - "Typed GROQ pipeline" notes full typegen coverage on this branch - Get-started flow uses the Translations toolbar + per-locale slugs - "Architecture → i18n" rewritten for document-per-locale + `language == $locale` GROQ filtering (no runtime resolver) Everything else (stack, env, scripts, tooling, deploy, going-deeper) matches the main README verbatim. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.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
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
Restructures and tightens the root README for the public release without changing the meaning of any existing claim. The repo's technical surface is unchanged.
Highlights
shields.iobadges (Next, React, Sanity, TypeScript, Tailwind, Biome, license). No emoji.variant/document-levelbranch and linking to PR [variant — do not merge] Document-level translation (alternative to field-level i18n) #62 so visitors immediately understand the parallel variant.packages/sanity-dataset-resolve/README.md(file doesn't exist; pointed at the inline-documentedsrc/index.tsinstead).pnpm strip-readmesutility gets one explicit mention so consumers know the documentation density is opt-in.Net
Test plan
pnpm lintclean (only the pre-existinguseOptionalChainwarning, unrelated)