Skip to main content

Getting Started with the Documentation Project

This guide covers how to set up and work with the documentation website locally.

Prerequisites​

  • Node.js version 20.0 or above
  • pnpm version 9 or above
tip

If you're new to pnpm, see our pnpm guide for installation and usage instructions.

Installation​

Install all dependencies:

pnpm install

Local Development​

Start the local development server:

pnpm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Open the documentation site in your browser: http://localhost:3000/

Local Setup with Local Docs​

If you want to work with local documentation from other repositories (e.g., qs-magellan, qs-webbloqs), you can configure local paths:

  1. Copy the example environment file:

    cp .env.example .env

  2. Adjust the paths in .env to point to your local repository clones:

    MAGELLAN_DOCS_PATH=/Users/your-username/path/to/qs-magellan/docs/magellan
    WEBBLOQS_DOCS_PATH=/Users/your-username/path/to/qs-webbloqs/docs/webbloqs

  3. You can comment out repositories you're not working on - they'll use placeholder docs.

See "Live Updates" in Updating Documentation for more details.

Build Commands​

  • pnpm build - Build the site for production
  • pnpm typecheck - Run TypeScript type checking
  • pnpm serve - Serve the production build locally (after running pnpm build)

Project Structure​

The documentation project uses Docusaurus and is organized as follows:

  • docs/ - Documentation source files
    • internal/ - Internal documentation (this section)
    • magellan/, webbloqs/, proxies/ - Project-specific documentation
  • src/ - React components and pages
  • sidebars/ - Sidebar configuration files
  • docusaurus.config.ts - Main Docusaurus configuration

Next Steps​