docs: Improve docs for vpx command.#1303
docs: Improve docs for vpx command.#1303connorshea wants to merge 2 commits intovoidzero-dev:mainfrom
Conversation
Just making it clear that it will install the package if it's not found, rather than just saying it "can" download it when needed.
✅ Deploy Preview for viteplus-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Clarifies vpx documentation to better describe its local-first execution and remote fallback behavior when the requested binary isn’t available locally.
Changes:
- Updates the overview bullet to say
vpx“will download” when a binary isn’t found locally. - Refines the
--package/-poption description to mention “additional packages”.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Options | ||
|
|
||
| - `-p, --package <name>` installs one or more packages before running the command | ||
| - `-p, --package <name>` installs one or more additional packages before running the command |
There was a problem hiding this comment.
The updated --package/-p description says “additional packages”, but vpx supports using --package to specify the package that provides the command when the binary name differs from the package name (e.g. vpx --package @pnpm/meta-updater meta-updater --help). Calling these “additional” can be misleading; consider rewording to “installs one or more packages before running the command” (or similar) so it covers both primary and extra packages.
| - `-p, --package <name>` installs one or more additional packages before running the command | |
| - `-p, --package <name>` installs one or more packages before running the command |
There was a problem hiding this comment.
I'm actually not sure why the previous docs were written this way about -p/--package if this is true? Were these docs AI-generated or is Copilot wrong 😅
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Connor Shea <connor.james.shea@gmail.com>
Just making it clear that it will install the package if it's not found, rather than just saying it "can" download it when needed.