Contributing to the H4H Documentation

This documentation is hosted on Github Pages and is built using mkdocs. If you would like to contribute to the documentation, you can do so by following the steps below.

Getting Started

Ensure you have pixi installed. If not, check out the pixi website for installation instructions.

1. Fork the repository
2. Clone the forked repository to your local machine
3. Run pixi install in the working directory to install the required dependencies
4. If you encounter any errors, please submit an issue on the repository
5. Checkout a new branch and update the documentation as required
6. Once the changes are ready, publish the branch to origin, and create a new pull request on the upstream repository

Updating the Documentation

The documentation is written in markdown and is located in the docs directory. To update the documentation, simply edit the markdown files in the docs directory.

If you are adding a new page, you will need to update the mkdocs.yml file to include the new page in the navigation.

To learn more about writing documentation check out the mkdocs documentation.

Building & Viewing the Documentation

We use pixi tasks to assist in common tasks. To build the documentation, run pixi run build. This will build the documentation and output the files to the site directory.

To view the documentation locally, run pixi run serve. This will start a local server and open the documentation in your default browser. You can then edit the documentation and see the changes in real-time.