Skip to content

chore(docs): move readme content to docs#1199

Open
markmichon wants to merge 1 commit into
mainfrom
chore/simplify-readme
Open

chore(docs): move readme content to docs#1199
markmichon wants to merge 1 commit into
mainfrom
chore/simplify-readme

Conversation

@markmichon
Copy link
Copy Markdown
Collaborator

Description

The client docs now live on sanity.io/docs

We've moved much of the readme's content into the official docs. All updates or new additions to client documentation (beyond the quickstart example that remains), should happen in one of the new docs articles starting with the link above.

The readme was reaching a size where it was hard to navigate, and reached a context window where it was hard for many LLM tools to consume.

What to review

Testing

@vercel
Copy link
Copy Markdown

vercel Bot commented Mar 9, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
tsdocs-client Ignored Ignored Mar 9, 2026 3:18pm

Request Review

@markmichon markmichon requested review from a team and laurenashpole and removed request for a team March 9, 2026 15:18
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 9, 2026

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 88.06% 3979 / 4518
🔵 Statements 88.06% 3979 / 4518
🔵 Functions 85.67% 317 / 370
🔵 Branches 89.13% 1173 / 1316
File CoverageNo changed files found.
Generated in workflow #4109 for commit ff5aaff by the Vitest Coverage Report Action

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