Skip to content

docs: refresh AI guidance for vp and Vite 8#658

Open
southpolesteve wants to merge 3 commits intomainfrom
codex/refresh-ai-docs-vp-vite8
Open

docs: refresh AI guidance for vp and Vite 8#658
southpolesteve wants to merge 3 commits intomainfrom
codex/refresh-ai-docs-vp-vite8

Conversation

@southpolesteve
Copy link
Collaborator

Summary

  • update repo-facing AI docs to use Vite+ / vp consistently for contributor workflows
  • keep vinext user migration guidance on plain Vite while steering new migrations toward Vite 8
  • refresh PR review / preview guidance, current CI wording, deploy flags, and fix the CLAUDE.md entrypoint symlink

Validation

  • vp run build
  • vp run check

@pkg-pr-new
Copy link

pkg-pr-new bot commented Mar 22, 2026

Open in StackBlitz

npm i https://pkg.pr.new/vinext@658

commit: 31741f8

@github-actions
Copy link

Example Preview Production Original
app-router-cloudflare preview production
pages-router-cloudflare preview production
app-router-playground preview production original
realworld-api-rest preview production
nextra-docs-template preview production
benchmarks preview production
hackernews preview production original

@southpolesteve
Copy link
Collaborator Author

/bigbonk review

Copy link
Contributor

@ask-bonk ask-bonk bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:vinext if 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 \n from 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) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ...

@ask-bonk
Copy link
Contributor

ask-bonk bot commented Mar 23, 2026

Review posted. Here's a summary of what I found:

Blocking issue: Two links in README.md contain hardcoded local paths (/Users/steve/.codex/worktrees/8805/vinext/...) that leaked from the authoring environment. These appear on lines 407 and 409 of the new README and will render as dead links on GitHub. They should be relative paths like the original (examples/app-router-nitro and examples/).

Everything else looks good:

  • The pnpm to vp migration across AGENTS.md, CONTRIBUTING.md, and README.md is consistent and correct
  • The Vite 8 baseline framing in the migration skill and compatibility docs is well-motivated
  • The side-by-side migration script approach (adding dev:vinext / build:vinext instead of overwriting) is a better workflow
  • Updated CI descriptions (7 E2E projects, unit + integration split, create-next-app) match what CI actually runs
  • The deploy-preview section correctly removes the /deploy-preview slash command reference and replaces it with the current fork-PR guidance
  • The vite-plus import guidance now correctly distinguishes between repo-owned surfaces and vinext runtime/public-facing code
  • The peer dep range correction (>=19.2.0 instead of ^19.2.4) matches the actual package.json
  • The CLAUDE.md change is just trimming a trailing newline from the symlink target

github run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant