Skip to content

Add a dedicated Package Management section with command reference pages #3041

Open

Description

@jong-kyung

Problem

Package management documentation currently lives on a single page under Guide. It combines package manager detection, global package behavior, and command usage.

This makes individual commands and package-manager-specific behavior harder to find. Package management is also less visible in the navigation than its range of functionality warrants.

Proposal

Add a top-level Package Management navigation entry with a dedicated sidebar, similar to pnpm’s task-based command navigation.

Cover all Vite+ package management commands, including vp install, vp add, and vp pm subcommands, rather than separating them by CLI prefix.

Documentation structure

Group command pages by purpose:

  • Getting started: overview, package manager selection, and global packages.
  • Dependency management: install, add, remove, update, and dedupe.
  • Inspection and diagnostics: list, why, info, outdated, and licenses.
  • Local development: link, unlink, rebuild, and patch commands.
  • Publishing: publish, version, dist-tag, and stage.
  • Registry and account management: login, logout, whoami, token, owner, and team.
  • Configuration and maintenance: config, pkg, and cache or store commands.

These are illustrative groups, not an exhaustive command list. The scope includes a complete command reference

Give each command its own page. Keep its subcommands and aliases together rather than creating separate pages for each spelling.

Page content

Each command page should explain:

  • Basic usage and examples.
  • Common options exposed by Vite+.
  • Support requirements across npm, pnpm, Yarn, and Bun.
  • Relevant behavior differences, including npm fallbacks and unsupported commands.
  • Links to upstream documentation for additional native options.

Keep shared concepts on separate pages and link to them from command pages. Avoid duplicating the full upstream package manager documentation.

Existing links

Keep the Guide entry as a link to the new section. Preserve the existing /guide/package-management URL and section anchors as a short compatibility page pointing readers to the corresponding new pages.

Expected outcome

Make Vite+ package management easier to discover and let users find a command’s usage and compatibility details without searching through a single combined guide.

Activity

  1. self-assigned this
    on Oct 14, 2026
  2. jong-kyung commented on Oct 14, 2026

    @jong-kyung
    CollaboratorAuthor

    @fengmk2 What do you think about adding a dedicated Package Management section to the docs?

  3. changed the title [-]docs: add a dedicated Package Management section with command reference pages[/-] [+]Add a dedicated Package Management section with command reference pages[/+] on Oct 14, 2026
  4. fengmk2 commented on Oct 14, 2026

    @fengmk2
    Member
  5. jong-kyung commented on Oct 14, 2026

    @jong-kyung
    CollaboratorAuthor

    LGTM, cc @TheAlexLichter @liangmiQwQ

    I'll prepare a draft PR once #3020, #3037, and #3040 are merged.

  6. liangmiQwQ commented on Oct 14, 2026

    @liangmiQwQ
    Collaborator

    LGTM, after all, who doesn't like cleaner and more detailed document?

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

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Fields

Priority

None yet

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions