Bringup Documentation

Source for docs.bringup.dev, built with Docusaurus 3.

Reading the docs? Go to docs.bringup.dev — you don't need this repo. What follows is for people editing the documentation.

Prerequisites

• Node.js 22 or newer
• pnpm, via Corepack: corepack enable

Local development

pnpm install

pnpm start

Serves at http://localhost:3000 with hot reload.

To check a production build — always do this before opening a pull request, because broken links fail the build (onBrokenLinks: 'throw'):

pnpm build

pnpm serve

Repository layout

docs/                     All site content, served at /
  index.mdx               Front page
  get-started/            Install → daemon → sign in → first device
  tutorials/              Task walkthroughs
  extensions/             One page per extension
    bag-master/
      flow-reference/     Flow YAML reference
  reference/              CLI, file locations, updates, daemon
  faq.mdx
  assets/screenshots/     Generated app screenshots
website/                  Docusaurus config, theme, custom components
  docusaurus.config.ts
  nginx.conf              Serves the built site in the container image
Dockerfile                Multi-stage build → nginx

Everything under docs/ is published. routeBasePath is / and the sidebar is autogenerated from the directory tree, so directory layout is navigation.

Writing documentation

Create a Markdown file under docs/ with frontmatter:

---
title: Page Title
sidebar_position: 3
description: One line describing the page.
---

Then stop — the sidebar builds itself. Do not edit sidebars.ts. To add or reorder a section, create or edit its _category_.json.

Use frontmatter title rather than a top-level # heading; Docusaurus renders the title as the page's h1, so doing both produces two.

Screenshots

Images under docs/assets/screenshots/ are captured from the real desktop app — none are mockups. The generator lives in the app repo (bringup_desktop_app, branch docs/screenshot-spec), not here:

npx playwright test e2e/screenshots.spec.ts

It writes PNGs into this repo. Convert them afterwards, since pages reference .webp and Playwright can only emit PNG — WebP is 55–88% smaller here with no visible quality loss. Needs ImageMagick:

find docs -name "*.png" -exec sh -c 'magick "$1" -strip -quality 82 "${1%.png}.webp" && rm "$1"' _ {} \;

Reference new screenshots as .webp.

Docker

The image builds the site and serves it with nginx:

docker build -t bringup-docs .

docker run -p 8080:80 bringup-docs

License

MIT