docs: npm install @tumaet/apollon is the whole install command - #825
Merged
Conversation
Every quickstart surface led with the five-peer install command, implying the peers must be installed by hand. They don't: npm 7+, pnpm 8+ (via auto-install-peers, default true since pnpm 8), and Bun install missing required peer dependencies automatically. Only Yarn never installs peers. - Lead every install snippet (root README, npm README, docs landing, quickstart, user overview, install/angular guides) with the bare one-liner, with the explicit peer list kept as the Yarn / pin-it-yourself path. - Fix the false claim in install.md and upgrading.md that pnpm users must add peers explicitly. - Fix the PNG/PDF renderer story: @resvg/resvg-wasm, jspdf, and svg2pdf.js are optionalDependencies of @tumaet/apollon, so a normal install brings them in automatically — they are not "optional peers" the consumer installs (explicit install only matters under --omit=optional). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Merged
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.
What
npm install @tumaet/apollonis the whole install command on modern package managers — but every quickstart surface led with the five-peer variant, implying the peers must be added by hand. Two claims in the docs were outright wrong. This PR makes the install story accurate and consistent everywhere.Facts (verified against
library/package.json+ package-manager docs)react,react-dom,@xyflow/react,yjs,y-protocols). npm 7+ installs missing peer dependencies automatically; pnpm auto-installs them viaauto-install-peers, defaulttruesince pnpm 8; Bun also installs peers. Yarn never installs peers.@resvg/resvg-wasm,jspdf,svg2pdf.js) areoptionalDependenciesof@tumaet/apollon— a normal install brings them in automatically. They are not "optional peers" the consumer must install.Changes
library/README.md), docs landing hero, library quickstart, user-guide overview, install + Angular guides. The explicit five-peer command stays as the Yarn / pin-versions-yourself path.install.mdandupgrading.mdsaid "pnpm and yarn users must add them explicitly" — wrong for pnpm 8+.install.md,api/export.md, and the npm README: optional dependencies install automatically; the explicit command only matters under--omit=optional.Verification
pnpm run lint:docsclean, Prettier clean, docs site builds.library/package.json(peerDependencies,optionalDependencies).🤖 Generated with Claude Code