Skip to content

Contributing to the documentation

You're welcome to contribute to this documentation whether you're a Deluge Community Firmware contributor or an enthusiastic Deluge user.

There are two ways to contribute:

  • Using the GitHub website, for contributing to individual pages
  • Using a local development environment, for contributing multiple pages, images, and changes to navigation or site configuration

Resources

If you want to talk with other Deluge documentation contributors, join the Deluge Community Discord and look for the Deluge Documentation Initiative channel.

Join the Deluge Community Discord

Requirements

To make changes to the site, you need a GitHub account.

Contributing through the GitHub website

If you want to work on individual pages, such as correcting a typo or expanding on a topic, you can do so through the GitHub website.

You need a GitHub account and permission to work on the project, but no other setup or tools are required.

  1. On the community documentation site, open the page you want to edit.

  2. Click Edit to open the page in GitHub.

    An image of the Edit button at the top of a documentation page

  3. Sign in to GitHub.

  4. Make the changes.

  5. Click Commit changes.

    An image of the Edit button at the top of a GitHub page

Contributing through a local development environment

If you want to make more substantial contributions, you can clone the repository to your local computer, make changes, then submit your changes back to the respository. This allows you to write in the code editor of your choice, work with multiple files, and preview the results.

Setting up a development environment

  1. Install Git.

  2. Install Python, Pip, and MkDocs by following the MkDocs Installation Guide.

  3. Install Material for MkDocs by following the instructions at Getting started.

  4. (Optional) Install VS Code to use as a code editor and help you manage your Git files.

Previewing your changes locally

MkDocs provides a local web server that lets you preview your changes as you work. Every time you save the file on your local machine, the website refreshes.

To turn on the local web server, open the terminal to your DelugeDocs\ directory and enter the following command: 

mkdocs serve

Submitting your changes

To submit changes back to the repository:

  1. Use Git to track changes in the files you modified.
  2. Commit the changes with a brief, descriptive commit message.

After commiting your changes, GitHub starts building the HTML for the site based on the updated files. This typically takes 30-60 seconds. When the build is complete, you can refresh the documentation site to see your changes.