Skip to content

docs(readme): polish for public release#63

Merged
damianrosellen1 merged 1 commit into
mainfrom
docs/readme-public-polish
May 28, 2026
Merged

docs(readme): polish for public release#63
damianrosellen1 merged 1 commit into
mainfrom
docs/readme-public-polish

Conversation

@damianrosellen1

Copy link
Copy Markdown
Collaborator

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

  • Stronger lead — one-line tagline + a row of shields.io badges (Next, React, Sanity, TypeScript, Tailwind, Biome, license). No emoji.
  • "Two flavours" section right under the lead, surfacing the variant/document-level branch and linking to PR [variant — do not merge] Document-level translation (alternative to field-level i18n) #62 so visitors immediately understand the parallel variant.
  • "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) — reads like feature cards, 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 from "Going deeper").
  • New "License" footer; "Requirements" moves to the bottom (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; pointed at the inline-documented src/index.ts instead).
  • The pnpm strip-readmes utility gets one explicit mention so consumers know the documentation density is opt-in.

Net

  • 271 → 213 lines.
  • 0 emoji.
  • All external + internal links resolve.

Test plan

  • pnpm lint clean (only the pre-existing useOptionalChain warning, unrelated)
  • All linked files exist (sanity-checked)
  • Badge URLs are static shields.io references (no auth-gated endpoints)

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 damianrosellen1 merged commit 965fcd7 into main May 28, 2026
4 of 5 checks passed
@damianrosellen1 damianrosellen1 deleted the docs/readme-public-polish branch May 28, 2026 22:24
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant