Skip to main content
We welcome issues and pull requests. Please review open discussions and the README before filing new proposals.

​
Where to start

​
Pull requests

  • Keep changes focused and include context in the description
  • Update docs in this site when public behavior changes
  • Add short YARD docstrings on new public APIs with @see links back to docs
  • Follow the Docs Style Guide

​
Running docs locally

# from the docs repo
npm i -g mint
mint dev

​
Reporting issues

  • Include Ruby/Rails versions, gem version, and repro steps
  • Share redacted dry_run! and explain output where relevant
  • If network-related, include Typesense version and whether you use a load balancer

​
Code of conduct

Be respectful and constructive. We aim for a helpful, collaborative environment.