Skip to content

Commit ed0ec7c

Browse files
authored
Merge pull request #25 from sfuosdev/issue-34/add-contribute-tutorial
add how to contribute tutorial
2 parents cd07b8e + c34a66f commit ed0ec7c

File tree

2 files changed

+19
-3
lines changed

2 files changed

+19
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
</h4>
55

66
<h4 align="center">SFU Open-source Development Club
7-
<br>SFU Open-source Development Club Documentation</h4>
7+
<br>Docusauraus Documentation Tool</h4>
88
<div align="center">
99
<br>
1010
<a href=".">
@@ -33,7 +33,7 @@ Thank you for your contributions and continued support!
3333

3434
### How to contribute
3535

36-
All the documentation needs to be done in markdown format and upload it to <code>docs</code> folder.
36+
All the documentation needs to be done in markdown format and upload it to <code>docs</code> folder.
3737

3838
If you have one markdown file, you have to add up sidebar position at the top of the markdown file like this:
3939

@@ -63,4 +63,15 @@ and have to add `_category_.json` file in the folder. The `_category_.json` file
6363
}
6464
```
6565

66-
To contribute, please submit a Pull Request. Our executive team will review and confirm your submissions before they are published.
66+
The format will look as this:
67+
68+
```txt
69+
── git-folder/
70+
│ ├── _catagory_.json
71+
│ ├── readme1.md
72+
│ ├── readme2.md
73+
│ ├── readme3.md
74+
│ ├── readme4.md
75+
```
76+
77+
To contribute, please submit a Pull Request. Our executive team will review and confirm your submissions before they are published.

docusaurus.config.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,11 @@ const config: Config = {
7777
position: "left",
7878
label: "Tutorial",
7979
},
80+
{
81+
label: "Contribute",
82+
position: "left",
83+
href: "https://github.com/sfuosdev/Docs?tab=readme-ov-file#how-to-contribute",
84+
},
8085
// {to: '/blog', label: 'Blog', position: 'left'},
8186
{
8287
href: "https://github.com/sfuosdev",

0 commit comments

Comments
 (0)