chore: add docs to pnpm-workspace#196
Conversation
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6c58ac318d
ℹ️ About Codex in GitHub
Codex has been enabled to automatically 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 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
commit: |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1bc0b42510
ℹ️ About Codex in GitHub
Codex has been enabled to automatically 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 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| - apps/* | ||
| - apps/vis/server | ||
| - apps/vis/web | ||
| - docs |
There was a problem hiding this comment.
Remove the standalone docs install path
Once docs is included in the workspace here, the existing root dev:docs script (package.json line 13) still runs pnpm -C docs install --ignore-workspace before starting VitePress. Because this commit deletes docs/pnpm-lock.yaml, anyone using pnpm run dev:docs now resolves a fresh standalone docs install outside the committed root lockfile and can recreate an untracked docs/pnpm-lock.yaml, so local docs development no longer uses the same dependency graph as CI. Please update that script to rely on the workspace install instead of --ignore-workspace.
Useful? React with 👍 / 👎.
| docs: | ||
| dependencies: |
There was a problem hiding this comment.
Add Vue as a direct docs dependency
After moving docs into the root workspace and deleting docs/.npmrc's shamefully-hoist=true, this importer no longer exposes transitive packages as if they were direct docs dependencies. The docs still import onMounted from vue in docs/index.md, but vue is only a transitive dependency of VitePress in the lockfile, so a normal pnpm workspace install can leave docs/node_modules/vue unresolved and make pnpm -C docs run build fail when Vite resolves that Markdown import. Please declare vue in docs/package.json so the workspace lockfile installs it for the docs package explicitly.
Useful? React with 👍 / 👎.
Problem
The
docsdirectory contains apackage.jsonand is a VitePress documentation site, but it is not included inpnpm-workspace.yaml. As a result, pnpm does not manage its dependencies as part of the monorepo workspace.What changed
Add
docsto thepackageslist inpnpm-workspace.yamlso that the documentation site is properly recognized as a workspace package.Checklist
gen-changesetsskill, or this PR needs no changeset.gen-docsskill, or this PR needs no doc update.