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.

Work in Progress

This guide is still being written. More detailed instructions will follow soon.

Quick Start

  1. Open the page you want to improve in your browser.
  2. Click the edit icon (pencil) in the top-right corner of the page — this takes you directly to the source file on GitLab.
  3. Make your changes in the GitLab web editor and submit a Merge Request.

A maintainer will review your proposal and merge it if appropriate.

Local Setup

For larger contributions, you can build the documentation locally:

git clone https://gitlab.kit.edu/kit/nhr-kit/docs.nhr.kit.edu.git
cd docs.nhr.kit.edu
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.