Where to Find the PI Desktop Documentation: A Complete Guide to the VitePress Site

The PI Desktop documentation resides in the docs/ directory of the vastsa/PI-Desktop repository, which is a VitePress site with docs/index.md serving as the main entry point.

The PI Desktop project maintains its comprehensive documentation as a static VitePress site directly within the source repository. All user guides, technical specifications, and architectural decision records are authored in Markdown and version-controlled alongside the application code. Understanding the file structure and build commands allows you to browse the docs offline or contribute improvements.

Locating the Documentation Source Files

The authoritative PI Desktop documentation source files live under the repository root in the docs/ directory. This location contains the entire VitePress configuration, Markdown content, and internationalization assets.

Directory Structure

The file tree organizes content by functional area:

/docs/
  ├─ index.md                # Landing page

  ├─ README.md               # Build instructions

  ├─ guide/                  # Quick start tutorials

  ├─ adr/                    # Architectural Decision Records

  ├─ plugin-development.md   # Extension authoring

  ├─ privacy-policy.md       # Legal information

  └─ zh-CN/                  # Chinese translation mirror

Critical Entry Points

• docs/index.md – The primary landing page providing product overview and navigation links.
• docs/README.md – Developer instructions for serving and building the documentation site.
• spec/README.md – Located outside the docs folder at the repository root, this file indexes technical specifications and API contracts.

Running the Documentation Locally

To view the PI Desktop documentation in a browser or verify changes before deployment, use the pnpm scripts defined in the repository's package.json.

First, install workspace dependencies:

pnpm install

Then start the development server with hot-reload enabled:

pnpm docs:dev

This command launches the VitePress site at http://localhost:5173. For static builds suitable for deployment, run:

pnpm docs:build    # Outputs to /docs/.vitepress/dist

pnpm docs:preview  # Verify the built site locally

Key Documentation Sections

The PI Desktop documentation is partitioned into distinct sections covering user guides, technical specifications, and extension development.

Quick Start Guide

Located at docs/guide/index.md, this section provides a concise walkthrough for new users setting up the application.

Technical Specifications

The spec/README.md file at the repository root serves as the English-language source of truth for API contracts, protocol definitions, and system architecture details.

Architectural Decision Records (ADRs)

Found under docs/adr/, these Markdown files (such as 0001-use-electron.md) document the rationale behind significant technical choices. The ADR index at docs/adr/README.md provides an ordered list of all decisions.

Plugin Development

The docs/plugin-development.md file contains comprehensive guidelines for building, packaging, and distributing PI Desktop plugins, including type definitions imported from @pi-desktop/shared.

Internationalization

A complete Chinese-language mirror exists in docs/zh-CN/, maintaining path-for-path parity with the English documentation.

Summary

• The PI Desktop documentation source is located in the docs/ directory of the vastsa/PI-Desktop repository, structured as a VitePress site.
• The entry point docs/index.md provides the landing page, while docs/README.md contains build instructions.
• Run pnpm docs:dev to serve the site locally at http://localhost:5173 with hot-reload enabled.
• Technical specifications are maintained separately in spec/README.md at the repository root.
• Plugin developers should consult docs/plugin-development.md for extension authoring guidelines.

Frequently Asked Questions

Where is the main entry point for the PI Desktop documentation?

The main entry point is docs/index.md in the repository root. This Markdown file renders as the landing page for the VitePress site and contains links to all major sections including the guide, specifications, and plugin development resources.

How do I build a static version of the PI Desktop documentation?

Run pnpm docs:build from the repository root. This command compiles the VitePress site into static HTML files located at /docs/.vitepress/dist, suitable for deployment to any static hosting provider.

Are the technical specifications located in the docs folder?

No. While user-facing documentation resides in docs/, the authoritative technical specifications and API contracts are located in spec/README.md at the repository root. This separation maintains a distinction between user guides and low-level system documentation.

Does the PI Desktop documentation support multiple languages?

Yes. The repository includes a Chinese-language mirror in the docs/zh-CN/ directory that maintains path-for-path parity with the English content, allowing users to access the same guides and specifications in their preferred language.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}