Skip to main content

Documentation contribution

Overview​

You can contribute to the project by writing documentation. Some ways to contribute:

  • Update existing documentation: You can help keep the documentation up-to-date by updating existing pages with new information or correcting errors.
  • Add new documentation: You can help expand the documentation by adding new pages or sections that cover topics not currently addressed.
  • Translate documentation: You can help make the documentation more accessible by translating it into other languages (coming soon).

Simple Steps to Contribute​

This option is for quick contributions. If you want to make more significant changes, please refer to the "Advanced Steps to Contribute" section below.

Team Members​

At the bottom of each page in the website, you will find an "Edit this page" link. Click on this link to open the page in GitHub. You can then make changes directly in GitHub and submit a pull request.

External Contributors​

If you are not a team member, you can still contribute to the project. Here's how:

  1. Fork the repository.
  2. Make changes to the documentation.
  3. Submit a pull request.

Advanced Steps to Contribute​

This step allow more flexibility. The documentation is written in Markdown and built using Docusaurus. You can learn more about Docusaurus by visiting the official website.

Local Setup​