Skip to content

Contributing to Docs

This site is intended to be community-managed. The goal is not just correctness, but clarity.

  • reduce ambiguity for first-time users
  • keep advanced behaviour discoverable for power users
  • preserve alignment with the actual product and release flow
  • use screenshots and command snippets when they remove guesswork
  1. Read the root CONTRIBUTING.md.
  2. Build the site locally.
  3. Check that your changes are still understandable to someone who has not read the codebase.
  4. Verify links and commands.
  • prefer direct, operational language
  • explain why a step exists, not just what to click
  • avoid hiding important caveats in footnotes
  • keep screenshots current with the shipping UI
Terminal window
pnpm install
pnpm build

Use pnpm dev while writing.

Edit page

Last updated: