Documentation Guide

How to Add Documentation

Create your documentation as Markdown (.md) files inside the docs/ folder.

Add links or references to these files in the mkdocs.yml configuration file.

Commit and push your changes to the repository.

Development Setup

To set up your local environment:

Use Python 3.10 (or compatible).

Install the required dependencies:

pip install mkdocs mkdocs-material pymdown-extensions mkdocstrings-python mkdocs-jupyter jupyter

Start the development server:

mkdocs serve

This will launch a local server so you can preview your documentation.

Once everything looks good, simply commit and push your updates.