docs: link related guides from the packages tables in READMEs - #1979
Merged
dinwwwh merged 1 commit intoSep 3, 2026
Merged
Conversation
Turn the Packages list in every README into tables with a Docs column, mirroring the API Reference page, so each package points at the guides that show it in use.
More templates
@orpc/ai-sdk
@orpc/arktype
@orpc/bun
@orpc/client
@orpc/cloudflare
@orpc/contract
@orpc/experimental-effect
@orpc/evlog
@orpc/hibernation
@orpc/json-schema
@orpc/experimental-msw
@orpc/nest
@orpc/next
@orpc/node
@orpc/openapi
@orpc/opentelemetry
@orpc/pinia-colada
@orpc/pino
@orpc/publisher
@orpc/ratelimit
@orpc/server
@orpc/shared
@orpc/swr
@orpc/tanstack-query
@orpc/trpc
@orpc/valibot
@orpc/zod
commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
Contributor
There was a problem hiding this comment.
✅ No new issues found.
Reviewed changes — converted the bullet-list Packages section in root README.md and all 27 package READMEs into prettier-aligned tables with a new Docs column of absolute https://orpc.dev/docs/... links, mirroring the API Reference page.
- All 39 unique docs links point to existing pages — verified every URL against
apps/content/docs(contract/*,plugins/*,helpers/*,integrations/*,openapi/*,rpc/*targets all resolve; no broken links). - Tables are byte-identical across all 28 files (each docs URL appears exactly 28× in the diff; spot-checked
packages/bunandpackages/sharedhunks directly). - Package rows preserve the old bullets' npm links, external links, and purpose text 1:1 — no package dropped or reworded.
@orpc/effect/@orpc/mswcorrectly map to theexperimental-*package rows (and likewise to their doc pages). - Docs-cell label choices match the existing API Reference page's "Related Guides" column per package, so readers land on the same guides the site points to.
- Sponsors section untouched, so the sync script is unaffected.
DeepSeek Flash (free via Pullfrog for OSS) | 𝕏
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.

The Packages section in every README is now a set of tables with a Docs column, mirroring the API Reference page. Each package row links to the guides that show it in use, so readers landing on npm or GitHub can jump straight to the relevant docs instead of only the package home page.
Changes
https://orpc.dev/docs/...) and every target page exists underapps/content/docs.Testing
eslint --max-warnings=0passes on all READMEs; prettier column-aligns the tables, which is why the diff is wide.