Getting Started

Table of Contents

• Prerequisites
• Set up
• First 15 minutes
• Run a dev server
• Common checks
• After first boot

Prerequisites

• Node.js 22+
• pnpm (the only supported package manager, never npm or yarn)

Set up

pnpm dev:setup

First 15 minutes

1. Configure the local shell and install dependencies with pnpm dev:setup.
2. Start the web app and local Tabby server with pnpm dev.
3. Open the docs route listed in Operational Reference.
4. Run the smoke check for the page you are changing.
5. Read Development Workflow before submitting work.

Run a dev server

Use pnpm dev for the app-hosted /docs route. Use pnpm docs:dev only for fast Markdown authoring feedback. Current dev server commands, local ports, branch hosts, and route facts are generated in Operational Reference.

Common checks

Use Testing to choose the smallest check for a code change. Current docs workflow checks and generated-reference checks are generated in Operational Reference.

After first boot

• Read Development Workflow before using branch hosts or submitting commit-owner requests.
• Use Contributing when adding docs, refreshing generated reference, or previewing /docs.
• Use Packages when you need the owning app, package, or generated reference page for an area.
• Use Testing to choose the narrowest check that proves your change.

[!INFO] The dev server runs on a fixed repo-owned port per app. If a port is busy, stop the stale process rather than letting it auto-increment.