Update the documentation

The documentation uses MkDocs with mkdocs-material.

1. Clone the repository:

   git clone https://gitlab.com/sylva-projects/sylva-elements/kunai.git
   cd kunai/mkdocs
   

2. Create a branch containing your change

   git checkout -b 'your-branch-name'
   

3. Create a virtual environment:

   python -m venv venv
   

4. Activate the virtual environment:

   • Linux/macOS:

     source venv/bin/activate
     

   • Windows:

     .\venv\Scripts\activate
     

5. Install dependencies:

   pip install -r requirements.txt
   

6. Run the MkDocs development server:

   mkdocs serve
   

7. Update the navigation (if necessary):

   python generate_index.py
   

8. Commit and push your changes:

   git add .
   git commit -m "fix: Update documentation"
   git push