Skip to content

Development

Maintainer: Milou Van Rijnbach, Matthias Saimpert

How to Contribute

This website uses MkDocs with Material theme, which provides an easy way to contribute content directly via the GitLab UI.

Steps to contribute:

  1. Navigate to the page you want to edit on the website.

  2. Click the pencil icon ✏️ at the top right of the page.
    This will open the Markdown source file in the GitLab web editor.

  3. Edit the content in the editor as you wish. Please make sure you also add an entry in the history page for any major change or important fix.

  4. Scroll down to the commit section:

  5. Enter a meaningful commit message describing your changes.

  6. Select “Create a new branch for this commit and start a merge request” option.

  7. Click Commit changes.
    GitLab will create a new branch and open a Merge Request (MR) automatically.

  8. Review and submit the MR for approval.
    Once merged, your changes will appear on the website after the next build.

If you need help or want to propose large changes, feel free to contact the maintainers.

📬 Maintainers
Matthias Saimpert
Milou Van Rijnbach

🖼️ Best Practices for Image Usage in Markdown

  • 📁 Store images under docs/img/your-topic/
    Example: docs/img/flex_qc/microscope_example.jpg

  • 🧭 Use relative paths from your .md file
    Example in procedures/flex_qc.md: markdown ![Microscope image showing detached wirebond on row 2](../img/flex_qc/microscope_example.jpg)

  • ChatGPT - OpenAI — An AI assistant useful for drafting, coding help, explanations, and technical writing.
Last update: 2025-07-16