docs: symlink root README to core and add ecosystem package table - #66
Conversation
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.
@standardserver/aws-lambda
@standardserver/core
@standardserver/fastify
@standardserver/fetch
@standardserver/node
@standardserver/peer
@standardserver/shared
commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Merging this PR will not alter performance
Comparing Footnotes
|
There was a problem hiding this comment.
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.mdrelative 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.
DeepSeek Flash (default — pick a model for stronger reviews) | 𝕏
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.
There was a problem hiding this comment.
✅ 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 moreadapter links, itspeer adapterreference, and the adapter READMEs' in-prose core/nodes links now usehttps://github.com/middleapi/standardserver/blob/main/packages/X/README.md. This resolves the prior IMPORTANT finding — no relative../X/README.mdlinks remain anywhere, so nothing resolves against the symlink's repo-root location on the home page. - Added
## Licensesections to all 7 package READMEs, each linking the repo'sLICENCEfile (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.
DeepSeek Flash (default — pick a model for stronger reviews) | 𝕏

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
README.mdis a symlink topackages/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.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.LICENCEfile.Notes for review
#the-standard-server-header,#how-body-parsing-works) are unchanged.