Give the npm README the full package-page treatment - #285
Merged
Conversation
Mirror the PyPI README's structure for the npm page: logo, badge row, tagline, why-section, the CI-notification quickstart with one-line sending and its rendered screenshot, documentation links, licensing, and contributing. Normalise the PyPI README's nine legacy /latest/ doc links to their current canonical paths while here.
nicklambourne
added a commit
that referenced
this pull request
Aug 17, 2026
Mirror the PyPI README's structure for the npm page: logo, badge row, tagline, why-section, the CI-notification quickstart with one-line sending and its rendered screenshot, documentation links, licensing, and contributing. Normalise the PyPI README's nine legacy /latest/ doc links to their current canonical paths while here.
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
1 participant
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.
Scope
The npm page rendered 34 clinical lines while PyPI got the full treatment.
typescript/README.mdnow mirrors the PyPI README's structure, TypeScript-flavoured: logo top-right, badge row (licenses, Node versions, npm version, downloads, TypeScript CI, docs), tagline, why-section, the CI-notification quickstart with one-line@slack/web-apisending and the rendered screenshot, documentation links, dual licensing, and contributing. All URLs are absolute (npm renders no relative links). While in the neighbourhood: the PyPI README's nine/latest/doc links (which survive only via legacy alias redirects) are normalised to their canonical current paths.Both package pages pick this up at the next publish — registry READMEs are frozen per released version.
Validation
The quickstart snippet was previously executed verbatim against the published package; every docs URL curl-verified 200; the packed tarball confirmed to ship the new README; badges verified rendering (including the scoped-package Node-versions badge).