docs: lead installs with npm and sync the StackBlitz lab to beta.9 - #58
Conversation
Two launch-readiness fixes. Install docs led with `pnpm add -D` in all six public install surfaces. The monorepo uses pnpm, but consumers mostly type npm, and a pnpm-first command reads as an extra prerequisite. Lead with npm and keep pnpm, Yarn, and Bun one click away. The release-policy gate constrains the specifier, not the client, so every variant still documents `causescope@beta`. StackBlitz lab was pinned to [email protected] while npm shipped beta.9. `verify:stackblitz` prints the mismatch but does not fail, so CI stayed green. Nothing was functionally broken (beta.9 changed only demo assets and an npm keyword), but the live lab is the first thing most readers open, so it should not trail the published version. Bumped the pin and regenerated the standalone lockfile; the lab is excluded from the workspace and carries its own. Verified: verify:release, verify:links, verify:stackblitz. Co-Authored-By: Claude Opus 5 <[email protected]>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 77ae0fd79d
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
AGENTS.md:3 prohibits introducing Bun into this repository. The install variant blocks added in the previous commit listed it alongside pnpm and Yarn across README.md, README.zh-CN.md, and docs/getting-started.md. npm stays as the leading command: the rule bars npm *lockfiles*, not npm as a documented client for consumers, and no lockfile is added here. Co-Authored-By: Claude Opus 5 <[email protected]>
|
Good catch — fixed in df53279.
Keeping |
1 participant
Two launch-readiness fixes.
Lead install commands with npm
All six public install surfaces led with
pnpm add -D causescope@beta. The monorepo uses pnpm, but consumers mostly typenpm, and a pnpm-first command reads as an extra prerequisite before you have even seen the tool work.Now
npm i -D causescope@betaleads, with pnpm / Yarn / Bun in a<details>block right below it.The
assertInstallDocumentationrelease gate constrains the specifier, not the client — its command pattern already matchesnpm install,npm i,yarn add, andbun add— so every variant still documentscausescope@betaand the gate is unchanged.Touched:
README.md,README.zh-CN.md,docs/getting-started.md,docs/index.md,packages/causescope/README.md. (docs/beta-testing.mdis on the checked list but only references the specifier inline, so it needed no change.)Sync the StackBlitz lab to beta.9
examples/stackblitz/package.jsonwas pinned to[email protected]while npm shippedbeta.9.Worth noting for future releases:
verify:stackblitzprints the mismatch and passes —— so CI stayed green through the drift. Nothing was functionally broken; beta.9 only changed demo assets and added the
vite-pluginnpm keyword, and the derived-condition tracing behind the demo landed in beta.8. But the live lab is the first thing most readers open, so it should not trail the published version.Bumped the pin and regenerated the lockfile. The lab is excluded from the workspace (
!examples/stackblitzinpnpm-workspace.yaml) and carries its ownpnpm-lock.yaml, so it was regenerated standalone with--ignore-workspace.Checks
pnpm verify:release— 11 policy tests pass, 6 public install surfaces, specifiercausescope@beta.pnpm verify:stackblitz— now reports beta.9 for release beta.9, with a real dev transform, source map, and clean production build.pnpm verify:links— passes.Follow-up worth considering
verify:stackblitzcould fail rather than report when the lab pin trails the repository release. That would have caught this at beta.9 instead of at launch prep. Left out of this PR since it changes CI gating behaviour.🤖 Generated with Claude Code