Skip to content

docs: clarify vp dev vs vp run dev / vpr dev#2255

Open
wan9chi wants to merge 2 commits into
mainfrom
docs/clarify-vp-dev-vs-vpr
Open

docs: clarify vp dev vs vp run dev / vpr dev#2255
wan9chi wants to merge 2 commits into
mainfrom
docs/clarify-vp-dev-vs-vpr

Conversation

@wan9chi

@wan9chi wan9chi commented Jul 26, 2026

Copy link
Copy Markdown
Member

Motivation

Make the difference between vp dev and vpr dev clear for humans and AIs.

Changes

  • The run guide has a new "Built-in Commands vs Scripts" section. The dev and test pages get the note the build page already had, and the troubleshooting entry now covers vp dev.
  • The generated agent instructions and the vp migrate --help prompt point at vpr <name> when the project defines that script or task.

Refs #2243

Built-in commands cannot be overwritten by `package.json` scripts, but the
docs and generated prompts still described Vite usage only in terms of
`vp dev` and `vp build`. That mixed guidance leads users and agents to run a
built-in command when they meant the project's own script.

- Add a "Built-in Commands vs Scripts" section to the run guide
- Note the built-in behavior on the dev and test pages, matching the build page
- Cover `vp dev` in the troubleshooting entry
- Name the `vpr` shorthand in the migration prompt and the READMEs
- Prefer `vpr <script>` in the generated agent instructions

Refs #2243
@netlify

netlify Bot commented Jul 26, 2026

Copy link
Copy Markdown

Deploy Preview for viteplus-preview ready!

Name Link
🔨 Latest commit a9ce1be
🔍 Latest deploy log https://app.netlify.com/projects/viteplus-preview/deploys/6a66cb8916b56c00082120e4
😎 Deploy Preview https://deploy-preview-2255--viteplus-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions

github-actions Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

✅ Staging deployment successful!

Preview: https://viteplus-staging.void.app/
Commit: a9ce1be

@wan9chi
wan9chi marked this pull request as draft July 26, 2026 11:47

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 0ea8a27eb0

ℹ️ 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".

Comment thread packages/cli/src/migration/bin.ts Outdated
@wan9chi
wan9chi marked this pull request as ready for review July 26, 2026 11:55
@wan9chi
wan9chi requested review from TheAlexLichter and cpojer July 26, 2026 14:13
Comment thread docs/guide/build.md Outdated
`vpr` is already introduced in the run guide, the guide index, and `vp help`,
so the prose does not need to spell out both forms, the same way the docs do
not pair `vp install` with `vp i`.
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.

2 participants