Skip to content

docs(pm): add dedicated package management docs and command reference - #3105

Open
jong-kyung wants to merge 12 commits into
voidzero-dev:mainfrom
jong-kyung:docs/package-management
Open

jong-kyung wants to merge 12 commits into
voidzero-dev:mainfrom
jong-kyung:docs/package-management

Conversation

@jong-kyung

Copy link
Copy Markdown
Collaborator

Summary

Make package management easier to discover and let users find command usage and compatibility details without searching through a single guide page.

  • Add a top-level Package Management section with a task-based sidebar and 38 command reference pages.
  • Document usage, options, package-manager compatibility, version requirements, npm fallbacks, and upstream references.
  • Separate shared guidance on package-manager selection, global packages, and native arguments from command-specific
    documentation.
  • Update guide links and CLI help URLs, and redirect legacy package-management and install URLs to the new section.

Compatibility

This replaces the former guide page with permanent redirects rather than retaining a compatibility page. The Guide sidebar
entry is removed, while links within the Guide point to the new section.

closes #3041

Introduce the package-management overview, package-manager selection, and global package guidance. Cover native arguments and integrity verification alongside version pinning.
Document 38 package-management commands and group them by task. Separate option descriptions from package-manager compatibility tables and native execution lists, with user-facing constraints and upstream references.
Add dedicated top-level navigation and a task-based sidebar. Remove the legacy guide and its Guide sidebar entry. Update guide links, install redirects, and CLI help to use the new section, with matching snapshots.
Redirect the former guide URL and its HTML and Markdown variants to the new package management overview with permanent redirects.
@jong-kyung

Copy link
Copy Markdown
Collaborator Author

@codex review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ⚠️ Failed 2026-10-18T12:58:18.928286Z 1788429 Draft marked ready
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@jong-kyung jong-kyung changed the title Docs/package management docs(pm): add dedicated package management docs and command reference Oct 18, 2026
@jong-kyung jong-kyung self-assigned this Oct 18, 2026

@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: 9a3df9b51b

ℹ️ 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 crates/vp_global_cli/src/help.rs
@jong-kyung

Copy link
Copy Markdown
Collaborator Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Something went wrong. Try again later by commenting “@codex review”.

Failed to sample tokens
ℹ️ 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".

Link to package-manager command guides and use explicit subcommand names.
Keep native argument guidance concise while preserving command limitations.
@jong-kyung

Copy link
Copy Markdown
Collaborator Author

@codex review

@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: 6400b1f1cf

ℹ️ 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 docs/public/_redirects Outdated
@jong-kyung

Copy link
Copy Markdown
Collaborator Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Can't wait for the next one!

Reviewed commit: 47f2b53afb

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

@jong-kyung
jong-kyung marked this pull request as ready for review October 18, 2026 12:50
@fengmk2 fengmk2 added the docs-preview Request a docs preview of the current fork PR commit; reapply after updates. label Oct 18, 2026

@liangmiQwQ liangmiQwQ left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I'm thinking about if we can still leave a Package Manager item in the Guide sidebar, but which's linked to this new dedicated page. Like Vite's document here:

2026-10-18.21-14-24.mov

@github-actions

Copy link
Copy Markdown
Contributor

Cloudflare documentation preview: https://pr-3105-viteplus-dev.voidzero-docs.workers.dev

Commit: 1788429

@jong-kyung

Copy link
Copy Markdown
Collaborator Author

I'm thinking about if we can still leave a Package Manager item in the Guide sidebar, but which's linked to this new dedicated page.

While working on this, I thought we might be able to remove it, but keeping it in the sidebar as a link to the new section, like Vite in your example, does make sense. I'll add it back. Thanks for the suggestion 💜

@liangmiQwQ

liangmiQwQ commented Oct 18, 2026 •

Copy link
Copy Markdown
Collaborator
image

Another nitpick is about the Package Manager navigation item in the topbar. it feels semantically a bit off to be at the same level as Guide and Config as a feature inside Vite+.

if this navigation item was removed, however, this useful document might be also difficult to find.

(This is a very subjective opinion; I think it requires further discussion.)

@jong-kyung

Copy link
Copy Markdown
Collaborator Author

Another nitpick is about the Package Manager navigation item in the topbar. it feels semantically a bit off to be at the same level as Guide and Config as a feature inside Vite+.

I'm still unsure about this too. I'm confident that having this guide will make things easier for users, but I wonder if a secondary navigation menu, similar to Bun's, might be a better fit.

image

@fengmk2

fengmk2 commented Oct 18, 2026

Copy link
Copy Markdown
Member

@TheAlexLichter need your help ❤️

@TheAlexLichter

Copy link
Copy Markdown
Member

(out for vacation but will have a look after!)

@fengmk2

fengmk2 commented Oct 19, 2026

Copy link
Copy Markdown
Member

https://viteplus-navigation-preview-20261019.elatedfox8.chatgpt.site/ Created a demo to give everyone some inspiration.

This branch has not been deployed

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

Labels

docs-preview Request a docs preview of the current fork PR commit; reapply after updates.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a dedicated Package Management section with command reference pages

4 participants