Documentation change
Change public documentation without drifting from package behavior.
Treat documentation as a product surface. A README-only correction still uses a pull request and the normal verification gate.
Confirm the contract
Check the current public API, supported versions, and actual package name. Do not copy an example from another repository without adapting and testing it.
Write with the repository's docs/WRITING.md rules. Put user outcomes before
implementation details. Use the smallest useful example.
Test the rendered result
Run pnpm docs:build. Review the Vercel preview on desktop and mobile. Test
navigation, search, code blocks, links, canonical metadata, feedback, and
assets affected by the change.
When an installation example changes, test it in a clean temporary consumer. Do not assume a workspace import proves the public package works.
Release npm README changes
npm renders the README stored in the tarball. A merged root README does not change an already published package page. Include important npm README fixes in the next package version. Use a patch release when the current README causes users to install or configure the package incorrectly.