Contributing to Documentation
Format of Documentation
Section titled “Format of Documentation”The documentation is written in Markdown, where its syntax can be found here: Markdown Guide.
The documentation is structured in a way that each section is a separate Markdown file, which can be found in the src/content/docs
directory.
The different sub-team documentations can be found in their respective directories.
Each file should have a blurb at the top, which is used to generate the sidebar and the page title.
How to Contribute
Section titled “How to Contribute”To contribute to the documentation, you can follow these steps:
- Clone the repository to your local machine.
- Navigate to the
src/content/docs
directory. - Create a new branch for your changes.
- Create or edit the Markdown files as needed.
- Note, when creating a new file, make sure to include the blurb at the top of the file.
---title: [Title here without brackets]description: [Description here without brackets]---