Skip to content

docs: link related guides from the packages tables in READMEs - #1979

Merged
dinwwwh merged 1 commit into
middleapi:mainfrom
dinwwwh:claude/readme-packages-docs-links-75d204
Sep 3, 2026
Merged

docs: link related guides from the packages tables in READMEs#1979
dinwwwh merged 1 commit into
middleapi:mainfrom
dinwwwh:claude/readme-packages-docs-links-75d204

Conversation

@dinwwwh

@dinwwwh dinwwwh commented Sep 3, 2026

Copy link
Copy Markdown
Member

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

  • Root README and all 27 package READMEs share the same updated section; the tables are byte-identical across files.
  • Package links, purposes, and their external links are unchanged; only the Docs column is new.
  • Docs links are absolute (https://orpc.dev/docs/...) and every target page exists under apps/content/docs.

Testing

  • eslint --max-warnings=0 passes on all READMEs; prettier column-aligns the tables, which is why the diff is wide.
  • The sponsors sync script only rewrites the Sponsors section, so it is unaffected.

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.
@pkg-pr-new

pkg-pr-new Bot commented Sep 3, 2026

Copy link
Copy Markdown
More templates

@orpc/ai-sdk

npm i https://pkg.pr.new/@orpc/ai-sdk@1979

@orpc/arktype

npm i https://pkg.pr.new/@orpc/arktype@1979

@orpc/bun

npm i https://pkg.pr.new/@orpc/bun@1979

@orpc/client

npm i https://pkg.pr.new/@orpc/client@1979

@orpc/cloudflare

npm i https://pkg.pr.new/@orpc/cloudflare@1979

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@1979

@orpc/experimental-effect

npm i https://pkg.pr.new/@orpc/experimental-effect@1979

@orpc/evlog

npm i https://pkg.pr.new/@orpc/evlog@1979

@orpc/hibernation

npm i https://pkg.pr.new/@orpc/hibernation@1979

@orpc/json-schema

npm i https://pkg.pr.new/@orpc/json-schema@1979

@orpc/experimental-msw

npm i https://pkg.pr.new/@orpc/experimental-msw@1979

@orpc/nest

npm i https://pkg.pr.new/@orpc/nest@1979

@orpc/next

npm i https://pkg.pr.new/@orpc/next@1979

@orpc/node

npm i https://pkg.pr.new/@orpc/node@1979

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@1979

@orpc/opentelemetry

npm i https://pkg.pr.new/@orpc/opentelemetry@1979

@orpc/pinia-colada

npm i https://pkg.pr.new/@orpc/pinia-colada@1979

@orpc/pino

npm i https://pkg.pr.new/@orpc/pino@1979

@orpc/publisher

npm i https://pkg.pr.new/@orpc/publisher@1979

@orpc/ratelimit

npm i https://pkg.pr.new/@orpc/ratelimit@1979

@orpc/server

npm i https://pkg.pr.new/@orpc/server@1979

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@1979

@orpc/swr

npm i https://pkg.pr.new/@orpc/swr@1979

@orpc/tanstack-query

npm i https://pkg.pr.new/@orpc/tanstack-query@1979

@orpc/trpc

npm i https://pkg.pr.new/@orpc/trpc@1979

@orpc/valibot

npm i https://pkg.pr.new/@orpc/valibot@1979

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@1979

commit: 8805ccc

@codecov

codecov Bot commented Sep 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@codspeed-hq

codspeed-hq Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Merging this PR will not alter performance

✅ 30 untouched benchmarks


Comparing dinwwwh:claude/readme-packages-docs-links-75d204 (8805ccc) with main (31cafad)

Open in CodSpeed

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ 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/bun and packages/shared hunks directly).
  • Package rows preserve the old bullets' npm links, external links, and purpose text 1:1 — no package dropped or reworded. @orpc/effect/@orpc/msw correctly map to the experimental-* 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.

Pullfrog  | View workflow run | Using DeepSeek Flash (free via Pullfrog for OSS) | 𝕏

@dinwwwh
dinwwwh merged commit e65e810 into middleapi:main Sep 3, 2026
11 checks passed
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