docs: refresh AI guidance for vp and Vite 8#658
Conversation
commit: |
|
|
/bigbonk review |
There was a problem hiding this comment.
Review: docs refresh for vp and Vite 8
Good overall direction — the pnpm → vp migration, Vite 8 baseline framing, side-by-side migration scripts, updated CI descriptions, and deploy-preview clarifications all look correct and well-motivated.
One blocking issue plus a few nits below.
Blocking
Hardcoded local paths leaked into README.md — Two links point at /Users/steve/.codex/worktrees/8805/vinext/... instead of relative repo paths. These render as dead links for every reader on GitHub.
Nits
-
SKILL.md Phase 5 formatting — "Or
npm run dev:vinextif you added parallel scripts." sits on its own line right after the numbered item, which makes it look like a separate list item instead of a continuation. Consider wrapping it in the same bullet, e.g.:1. Run `vinext dev` (or `npm run dev:vinext` if you added parallel scripts) to start the development server -
CLAUDE.md trailing-newline removal — harmless, but worth noting this is just stripping
\nfrom the symlink target, not a content change.
README.md
Outdated
| | RealWorld API | REST API routes example | [realworld-api-rest.vinext.workers.dev](https://realworld-api-rest.vinext.workers.dev) | | ||
| | Benchmarks Dashboard | Build performance tracking over time (D1-backed) | [benchmarks.vinext.workers.dev](https://benchmarks.vinext.workers.dev) | | ||
| | App Router + Nitro | App Router deployed via Nitro (multi-platform) | [examples/app-router-nitro](examples/app-router-nitro) | | ||
| | App Router + Nitro | App Router deployed via Nitro (multi-platform) | [examples/app-router-nitro](/Users/steve/.codex/worktrees/8805/vinext/examples/app-router-nitro) | |
There was a problem hiding this comment.
These two links contain hardcoded local paths (/Users/steve/.codex/worktrees/8805/vinext/...) that leaked from the authoring environment. They will render as dead links on GitHub for everyone else.
Should be relative paths, matching the original:
| App Router + Nitro | ... | [examples/app-router-nitro](examples/app-router-nitro) |
Additional checked-in examples ... live under [`examples/`](examples/), including ...|
Review posted. Here's a summary of what I found: Blocking issue: Two links in Everything else looks good:
|
Summary
vpconsistently for contributor workflowsCLAUDE.mdentrypoint symlinkValidation
vp run buildvp run check