Ga naar inhoud

Contributing to our Documentation

Thank you for your interest in contributing to the Netherlands3D documentation. This guide provides all the necessary information to help you get started with contributing to our documentation, which is composed of Markdown documents in our GitHub repository and is automatically built using MkDocs whenever a pull request is merged.

Getting Started

First, you'll need to set up your environment for making contributions:

  1. Fork the Repository: Go to and fork the repository to your GitHub account.
  2. Clone the Fork: Clone your forked repository to your local machine to make changes.
  3. Install MkDocs (Optional): If you wish to preview your changes locally, you'll need to install MkDocs. Follow the installation guide on their website.

Making Contributions

Language and Voice

  • For user and organisation facing parts of the documentation, write in Dutch using the passive voice.
  • For developer-facing documentation, write in English.

Adding or Editing Content

  1. Create a New Branch: Before making any changes, create a new branch in your forked repository.
  2. Add/Edit Markdown Files: Make your changes or add new content in the appropriate Markdown (.md) files. Be sure to follow the language and voice guidelines mentioned above.
  3. Update mkdocs.yml: If you are adding a new page, don't forget to update the mkdocs.yml configuration file to include your new page in the navigation.

Previewing Your Changes

If you've installed MkDocs locally, you can preview your changes by running the following command in your project directory:

mkdocs serve

This will start a local web server. Open your web browser and go to to see your changes.

Submitting Your Contributions

Once you are satisfied with your changes:

  1. Commit Your Changes: Add your changes to your fork and commit them with a clear commit message.
  2. Push to Your Fork: Push your changes to your GitHub fork.
  3. Create a Pull Request: Go to the original Netherlands3D/docs repository and create a new pull request. Target the main branch for your pull request and provide a clear description of your changes.
  4. Review Process: Your pull request will be reviewed by the Netherlands3D documentation team. Be open to feedback and make any requested changes.


Contributing to the Netherlands3D documentation is a collaborative effort. We appreciate your willingness to contribute and look forward to improving our documentation with your help. If you have any questions or need assistance, please open an issue in the GitHub repository.