Documentation

This documentation is built using mdBook, which creates modern online books from a collection of Markdown files.

Build docs Locally

Install mdBook in your system using these instructions

cd docs
mdbook serve --open

Note: the rendered output under docs/book/ is generated by mdBook. Edit the sources in docs/src/ instead.

Automated Deployment

The documentation is automatically deployed to GitHub Pages via GitHub Actions. The deployment process is triggered by pushing to the main branch.

Contributing

Documentation is usually the weakest link in most open-source projects. We would greatly appreciate your help in improving this documentation. If you find any errors or have suggestions for improvements, don’t hesitate to open an issue or a pull request. Thank you in advance!