Contributing to Docs
This site is intended to be community-managed. The goal is not just correctness, but clarity.
What good documentation changes do
Section titled “What good documentation changes do”- 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
Before you open a pull request
Section titled “Before you open a pull request”- Read the root CONTRIBUTING.md.
- Build the site locally.
- Check that your changes are still understandable to someone who has not read the codebase.
- Verify links and commands.
Content standards
Section titled “Content standards”- 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
Local validation
Section titled “Local validation”pnpm installpnpm buildUse pnpm dev while writing.