Contributing

Thank you for investing your time in contributing to GDevelop's documentation! Any contribution you make will be reflected on wiki.gdevelop.io ✨.

In this guide, you will get an overview of the contribution workflow.

Make a contribution

To make a contribution, follow those steps:

Fork this repository
Install the project
Find an issue that you can resolve
Open a Pull Request
Once your Pull Request is merged, the documentation will automatically be updated with your changes (a few minutes for changes to take effect)

First install:

Run:

poetry install --no-root

poetry run mkdocs serve
# Or, for faster reload after changes:
poetry run mkdocs serve --dirtyreload

This will run the documentation on http://localhost:8000.

Once you have the documentation running locally, you can start to contribute to the documentation.

GDevelop's documentation is based on Material for MkDocs and uses different plugins.

If you need to add a python package, add it with poetry:

poetry add package

And then update the requirements.txt file (used by vercel to deploy the documentation) with:

poetry export -f requirements.txt --output requirements.txt