How to contribute to the Chao Modding Documentation:

The Chao Modding Documentation is written in standard markdown formatting, and formatted through MKDocs with the MKDocs-Material theme. Contributing to the documentation allows for a centralized community space where modders can learn how to do stuff.

Prerequisites

• Git
• A Github Account
• A Text Editor of choice (VSCode is recommended)

Getting started

Fork the project by pressing the Fork button on Github on the github repository/ and pull/clone your repository.

Create a branch of the forked repository, so that you can make changes as necessary.

Make changes as necessary, and commit and push your features.

Don't forget to add the fork as an upstream remote! This will help when you open up a pull request on Github!

Push your commit to the branch you created.

Open your branch and submit a pull request. The main branch then gets a request from you with your contribution counting towards the project.

Making changes

Open the .md file of choice that needs to be changed with an editor of choice. Make the necessary changes and then save. Create a Pull Request with the changes and request for them to be pulled into the Master repository to be built. Thereafter, it will be built into the main MKDocs repository.

Special plugins

MKDocs material has a few extra plugins enabled in this documentation, allowing some extra syntactial sugar to be added to make the guides prettier. Clicking the links below will take you to the relevant MKDocs Material documentation for each plugin that is actively used:

• Admonitions
• Python Markdown: Keys
• Social Cards

Creating new topics

Create a new .md file with the topic you'd like to add, add the topic in the "mkdocs.yml" file, and then make a Pull Request.

Adding Issues

If you have any issues with the documentation, open an issue on the github repository and it will be assigned a fix as soon as a build is done.