🚧 This website is still under construction. Please stay tuned. 🚧
Developers
API
Contributing

Contributing

The easiest way to start developing is to use devenv (opens in a new tab) via the provided flake.nix. So, clone this repository and run:

# If you have Nix installed
nix develop --impure
# This will drop you into a shell with all the dependencies installed
# If you want to bring up a meilisearch instance, simply run:
devenv up

Small note: If editing the README, please conform to the standard-readme (opens in a new tab) specification. Also, please ensure that documentation is kept in sync with the code. Please note that the main documentation repository is added to this repository via git-subrepo (opens in a new tab). To update the documentation, please use the following commands:

git-subrepo pull docs
cd ./docs
 
# Make your changes
git commit -am "docs: update documentation for new feature"
 
# Preview your changes
pnpm install
pnpm run dev
 
# If you're happy with your changes, push them
git-subrepo push docs