Skip to content

Contributing

Welcome!

Contributions are welcome! If you'd like to improve the docs builder, feel free to open a pull request.

Development Process

  1. Create a branch from main
  2. Make your changes
  3. Test your changes locally (see Local Development)
  4. Open a pull request

Testing

We don't have automated tests set up yet, so please verify your changes work before submitting:

  • For TypeScript changes: Build and run locally
  • For Python/MkDocs changes: Preview with mkdocs serve
  • For infrastructure changes: We work directly on the production environment, but the blast radius is limited—worst case, the site stops receiving updates until a rollback is deployed

If you're unsure, reach out to other contributors or mention it in your PR. We're happy to help test and review.

Code Style

  • TypeScript: Follow existing patterns in the codebase
  • Python: Standard Python conventions
  • Keep changes focused and minimal

That's it! We appreciate your contributions.

Last updated: March 31, 2026 at 11:02
By: Axel Tetzlaff