Skip to content

docs: symlink root README to core and add ecosystem package table - #66

Merged
dinwwwh merged 2 commits into
mainfrom
claude/readme-symlinks-package-table-211334
Aug 14, 2026
Merged

docs: symlink root README to core and add ecosystem package table#66
dinwwwh merged 2 commits into
mainfrom
claude/readme-symlinks-package-table-211334

Conversation

@dinwwwh

@dinwwwh dinwwwh commented Aug 14, 2026

Copy link
Copy Markdown
Member

The root README is now a git symlink to packages/core/README.md, making the core doc the single source of truth for both the repo front page and the core package. Every package README opens with the same table of ecosystem packages, and the core README explains each body type with examples.

Changes

  • Root README.md is a symlink to packages/core/README.md; the core README is retitled "Standard Server" and its adapter quick-start duplication is gone — each adapter README already covers its own quick start.
  • All seven package READMEs carry an identical ecosystem package table near the top. Cross-package links use absolute GitHub URLs, so they resolve from the symlinked root view and on npm alike.
  • The core README's "Body types" section now documents each content type (JSON, FormData/URLSearchParams, File/Blob, event-stream, octet-stream) with runnable examples, including the auto-set headers and the empty-array removal trick.
  • The peer README gains a "Body resolution" section explaining that resolveBody(hint?) ignores the hint there: the peer protocol transmits bodies in structured form, so there are no raw bytes for a hint to reinterpret. The core README's peer note links to it.
  • Every package README ends with a License section in the oRPC style, linking the repo's LICENCE file.
  • "Learn more" sections no longer link the root README and core doc separately, since they are now the same document.

Notes for review

  • Anchors other READMEs rely on (#the-standard-server-header, #how-body-parsing-works) are unchanged.

The core README now doubles as the repo front page via a root symlink,
gains per-body-type sections (JSON, forms, file, event-stream,
octet-stream), and every package README opens with the same ecosystem
package table using relative links. The peer README documents why
resolveBody ignores the hint argument.
@pkg-pr-new

pkg-pr-new Bot commented Aug 14, 2026

Copy link
Copy Markdown
@standardserver/aws-lambda

npm i https://pkg.pr.new/@standardserver/aws-lambda@66

@standardserver/core

npm i https://pkg.pr.new/@standardserver/core@66

@standardserver/fastify

npm i https://pkg.pr.new/@standardserver/fastify@66

@standardserver/fetch

npm i https://pkg.pr.new/@standardserver/fetch@66

@standardserver/node

npm i https://pkg.pr.new/@standardserver/node@66

@standardserver/peer

npm i https://pkg.pr.new/@standardserver/peer@66

@standardserver/shared

npm i https://pkg.pr.new/@standardserver/shared@66

commit: 53552b5

@codecov

codecov Bot commented Aug 14, 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 Aug 14, 2026

Copy link
Copy Markdown
Contributor

Merging this PR will not alter performance

✅ 26 untouched benchmarks
⏩ 108 skipped benchmarks1


Comparing claude/readme-symlinks-package-table-211334 (53552b5) with main (3a37224)

Open in CodSpeed

Footnotes

  1. 108 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@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.

Important

The relative links in the core README (which now doubles as the root README via symlink) break on the repo home page. See the inline comment — a cheap pre-merge fix (/packages/... root-absolute paths) removes the ambiguity you flagged in "Notes for review" rather than gambling it survives the post-merge visual check.

Reviewed changes — this doc-only PR makes packages/core/README.md the single source of truth by symlinking the root README.md to it, and standardizes every package README:

  • Root README → symlink: the 142-line root README (badges, why, packages, full sponsor tables) is replaced by a git symlink to packages/core/README.md; the core README is retitled "Standard Server" and its duplicate adapter quick-start is removed.
  • Ecosystem package table: all eight READMEs (core + 7 packages) now open with an identical table of the ecosystem packages via ../X/README.md relative links.
  • Core "Body types" section: new subsections document JSON, FormData/URLSearchParams, File/Blob, event-stream, and octet-stream bodies with runnable examples, including the auto-set headers and the empty-array removal trick.
  • Peer "Body resolution" section: explains why resolveBody(hint?) ignores the hint in the peer adapter (structured transport, no raw bytes); the core README's HTTP-scope note now links to it.
  • "Learn more" de-duplication: adapter READMEs point at core instead of both root and core, since they are now the same document.

I verified the technical claims against source: withEventMeta(container, meta) and the ErrorEvent(data, options) signatures match the examples (packages/core/src/event-stream/meta.ts:11, packages/core/src/event-stream/error.ts:8); the auto-set-header claims match node/fetch senders (packages/*/src/body.ts); the anchors other READMEs rely on (#the-standard-server-header, #how-body-parsing-works, #event-stream-helpers) are unchanged; the sponsor tables and "37 past sponsors" line are preserved in core; and scripts/sync-sponsors.ts keeps working (it skips symlinks via entry.isFile(), so it rewrites packages/core/README.md, which the root symlink mirrors). The only finding is the symlink link-resolution issue below.

Pullfrog  | Fix all ➔Fix 👍s ➔View workflow run | Using DeepSeek Flash (default — pick a model for stronger reviews) | 𝕏

Comment thread packages/core/README.md Outdated
Cross-package links now use absolute GitHub URLs so they resolve from
the symlinked root README and on npm. Every package README ends with a
License section matching the oRPC style.

@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 — Incremental review of the delta since the prior pullfrog review (ac614f6):

  • Converted all cross-package links to absolute GitHub URLs: the ecosystem tables in all 8 READMEs, the core README's Learn more adapter links, its peer adapter reference, and the adapter READMEs' in-prose core/nodes links now use https://github.com/middleapi/standardserver/blob/main/packages/X/README.md. This resolves the prior IMPORTANT finding — no relative ../X/README.md links remain anywhere, so nothing resolves against the symlink's repo-root location on the home page.
  • Added ## License sections to all 7 package READMEs, each linking the repo's LICENCE file (verified present, British spelling) — consistent across every package.

I re-checked the current tree: zero relative ../ cross-directory links remain in any README, and the new License links point to the actual LICENCE file. Prior feedback is fully addressed.

Pullfrog  | View workflow run | Using DeepSeek Flash (default — pick a model for stronger reviews) | 𝕏

@dinwwwh
dinwwwh merged commit a78a0dd into main Aug 14, 2026
10 of 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