Skip to content

Commit 0edcab7

Browse files
authored
feat: add documentation contribution guidelines (#2)
1 parent 692cff5 commit 0edcab7

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

src/content/docs/gcs/documentation.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Contributing to Documentation
3+
sidebar:
4+
order: 1
5+
---
6+
7+
## Format of Documentation
8+
The documentation is written in Markdown, where its syntax can be found here: [Markdown Guide](https://www.markdownguide.org/basic-syntax/).
9+
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.
10+
The different sub-team documentations can be found in their respective directories.
11+
Each file should have a blurb at the top, which is used to generate the sidebar and the page title.
12+
13+
## How to Contribute
14+
To contribute to the documentation, you can follow these steps:
15+
1. Clone the repository to your local machine.
16+
2. Navigate to the `src/content/docs` directory.
17+
3. Create a new branch for your changes.
18+
4. Create or edit the Markdown files as needed.
19+
- Note, when creating a new file, make sure to include the blurb at the top of the file.
20+
```
21+
---
22+
title: [Title here without brackets]
23+
description: [Description here without brackets]
24+
---
25+
```

0 commit comments

Comments
 (0)