Skip to content

Contributing to the Documentation

This documentation is maintained as a Git repository on GitLab and built with Zensical. Everyone with a KIT account is welcome to suggest improvements — either by reporting an issue or by editing the source directly.

Reporting an Issue

If you notice an error, outdated content, or missing information but do not want to edit the source yourself, open an issue in the GitLab issue tracker. Please include the URL of the affected page and a brief description of the problem.

Contributing Content

Workflow

  1. Clone the repository and set up the local development environment (see Local Setup below).
  2. Create a new feature branch for your changes.
  3. Edit the relevant Markdown files under docs/ and commit your changes to the branch.
  4. Push the branch and open a Merge Request on GitLab.
  5. A maintainer will review your proposal and merge it if appropriate.

Local Setup

To build the documentation locally:

git clone https://gitlab.kit.edu/kit/nhr-kit/docs.nhr.kit.edu.git
cd docs.nhr.kit.edu
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
zensical serve

The site will be available at http://localhost:8000.

Guidelines

  • Write in clear, concise English.
  • Keep pages focused — one topic per page.
  • Follow the existing structure and formatting conventions.
  • Add or update navigation entries in mkdocs.yml when adding new pages.