Walkthrough

Registers a new @docusaurus/plugin-content-docs instance for pnpr in docusaurus.config.ts, updates the navbar and footer to link to it, and adds nine new pnpr-docs/ markdown pages covering introduction, installation, quick start, CLI reference, configuration, storage backends, auth backends, install acceleration, and licensing, along with a sidebars-pnpr.json sidebar definition.

Changes

pnpr docs section

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 Hop hop, the docs are here at last,
New pages planted, growing fast!
A registry server, Rust and bright,
With sidebars, config, install delight.
The pnpr bunny left a trail—
From quick start guides to storage tales! 🌿

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

• X
• Mastodon
• Reddit
• LinkedIn

• Add a dedicated Docusaurus docs instance for pnpr under the /pnpr route.
• Introduce pnpr documentation set (intro, install, config, storage, auth, CLI, licensing).
• Wire pnpr docs into navbar and existing docs routing for discoverability.

graph TD
  A(["Docusaurus site"]) --> B["Docs plugin: default"] --> C["Client docs (/)"]
  A --> D["Docs plugin: pnpr"] --> E["pnpr-docs (md)"] --> F["pnpr sidebar JSON"]
  A --> G["Navbar + footer links"] --> D

  subgraph Legend
    direction LR
    _site(["Site/UI"]) ~~~ _plugin["Plugin instance"] ~~~ _files["Content/config files"]
  end

Loading

The following are alternative approaches to this PR:

1. Merge pnpr docs into existing default docs tree

• ➕ No multi-instance docs plugin configuration
• ➕ Unified search/sidebar structure across all docs
• ➖ Mixes server (pnpr) and client (pnpm) docs, potentially confusing IA
• ➖ Harder to evolve pnpr docs independently (separate editUrl/pathing)

2. Create a separate Docusaurus site for pnpr

• ➕ Full isolation of navigation, theming, and build settings
• ➕ Clear product separation
• ➖ More operational overhead (build/deploy, versioning, search)
• ➖ More friction to cross-link between pnpm and pnpr docs

3. Use Docusaurus docs versions instead of a second docs instance

• ➕ Built-in mechanism for parallel doc sets over time
• ➕ Potentially simpler than multi-instance if pnpr is treated as a versioned track
• ➖ Versions are intended for time-based versions, not product-based separation
• ➖ May complicate URLs and contributor mental model

Recommendation: The chosen approach (a second docs plugin instance with its own routeBasePath and sidebar) is a good fit for product separation while keeping a single site/build. It preserves a clean /pnpr namespace, allows independent sidebar organization and editUrl, and avoids the overhead of a separate site. Ensure search/indexing and any global docs assumptions (e.g., default docs-only nav items) behave correctly with multi-instance docs.

Documentation (9) +575 / -0

auth-backends.mdDocument shared-SQL auth backends for pnpr replicas +91/-0

Document shared-SQL auth backends for pnpr replicas

• Adds documentation explaining per-instance auth state vs shared SQL backends for horizontal scaling. Describes supported backends (libsql/Turso, Postgres, MySQL), required Cargo features, and configuration examples.

pnpr-docs/auth-backends.md

cli.mdAdd pnpr CLI reference page +47/-0

Add pnpr CLI reference page

• Documents pnpr command-line flags and their behavior, including config selection, listen/storage/cache overrides, public URL rewriting, and OSV options. Includes logging guidance via RUST_LOG and usage examples.

pnpr-docs/cli.md

configuration.mdAdd pnpr configuration reference (verdaccio-shaped YAML) +129/-0

Add pnpr configuration reference (verdaccio-shaped YAML)

• Introduces a configuration guide covering storage/cache, uplinks, packages access rules, and auth defaults. Documents environment variable substitution and links to related pages (auth backends, CLI logging, storage backends).

pnpr-docs/configuration.md

install-acceleration.mdExplain pnpr install acceleration feature and flow +68/-0

Explain pnpr install acceleration feature and flow

• Describes how pnpr can offload dependency resolution to the server to reduce latency-bound graph walking. Documents the high-level request/response flow and how to enable it via pnpm-workspace.yaml.

pnpr-docs/install-acceleration.md

installation.mdAdd pnpr installation instructions for npm-distributed binary +33/-0

Add pnpr installation instructions for npm-distributed binary

• Documents installing @pnpm/pnpr globally via pnpm and explains the platform-specific binary wrapper packages. Includes verification and pointers to next steps.

pnpr-docs/installation.md

introduction.mdAdd pnpr introduction and experimental disclaimer +46/-0

Add pnpr introduction and experimental disclaimer

• Introduces pnpr as a Rust npm-registry-compatible server and positions it relative to pnpm and verdaccio. Adds an explicit experimental disclaimer and summarizes use cases and licensing model.

pnpr-docs/introduction.md

license.mdAdd pnpr license and trademark notice page +22/-0

Add pnpr license and trademark notice page

• Documents pnpr's PolyForm Shield source-available license and non-compete constraint, with links to upstream license and contribution terms. Adds a trademark/affiliation disclaimer for npm/GitHub/Microsoft.

pnpr-docs/license.md

quick-start.mdAdd pnpr quick start: run server, point client, publish +44/-0

Add pnpr quick start: run server, point client, publish

• Provides a basic workflow to run pnpr with defaults, configure a client to use it as registry, and publish a package. Links to deeper references (CLI, configuration, install acceleration).

pnpr-docs/quick-start.md

storage.mdDocument S3-compatible storage backend configuration +95/-0

Document S3-compatible storage backend configuration

• Explains the split between hosted storage and cache, and how an s3: block moves hosted packages into S3/R2/MinIO-compatible storage. Includes option reference and end-to-end configuration examples.

pnpr-docs/storage.md

Other (2) +44 / -1

docusaurus.config.tsRegister pnpr docs plugin and add navbar/footer links +25/-1

Register pnpr docs plugin and add navbar/footer links

• Adds a second @docusaurus/plugin-content-docs instance with id 'pnpr' serving content from ./pnpr-docs under routeBasePath 'pnpr' and using a dedicated sidebar file. Updates navbar label for existing docs and adds a 'Registry (pnpr)' docs sidebar entry, plus a footer/docs link to the pnpr section.

docusaurus.config.ts

sidebars-pnpr.jsonDefine pnpr docs sidebar structure +19/-0

Define pnpr docs sidebar structure

• Adds a dedicated sidebar for the pnpr docs section, ordering intro/install/quickstart/CLI and grouping configuration subtopics. Used by the new pnpr docs plugin instance.

sidebars-pnpr.json