Merge pull request #24 from sfuosdev/issue-23/change-readme

Issue 23/change readme

Author: TommyOh0428

README.md

@@ -1,4 +1,25 @@
-# SFU Open Source Development Club Documentation 
+<h4 align="center">
+    <br> <img src="static/img/logo.png" alt="osdev logo">
+    <img src="static/img/docusaurus.png" alt="docusaurus logo"></a> 
+</h4>
+
+<h4 align="center">SFU Open-source Development Club
+    <br>SFU Open-source Development Club Documentation</h4>
+    <div align="center">
+    <br>
+        <a href=".">
+          <img src="https://github.com/sfuosdev/Docs/actions/workflows/deploy.yml/badge.svg"/>
+        </a>
+    </div>
+</h4>
+
+<p align="center">
+    <a href="#what-is-this">What is this?</a> •
+    <a href="#purpose-of-this-tool">Purpose of this tool</a> •
+    <a href="#how-to-contribute">How to contribute</a>
+</p>
+
+### What is this?
 
 This SFU OS Dev Documentation tool is built using [Docusaurus](https://docusaurus.io/), a modern static website generator and hosted by Github Page.
 
@@ -14,4 +35,32 @@ Thank you for your contributions and continued support!
 
 All the documentation needs to be done in markdown format and upload it to <code>docs</code> folder. 
 
+If you have one markdown file, you have to add up sidebar position at the top of the markdown file like this:
+
+```markdown
+---
+sidebar_position: 2
+---
+```
+
+If you have multiple markdown files, you should make a folder and add all your markdown files in that folder. Then you have to add up sidebar position at the top of the each markdown file like this:
+
+```markdown
+---
+sidebar_position: 2
+---
+```
+
+and have to add `_category_.json` file in the folder. The `_category_.json` file should look like this:
+
+```json title="_category_.json"
+{
+  "label": "Git Documentation",
+  "position": 1,
+  "link": {
+    "type": "generated-index"
+  }
+}
+```
+
 To contribute, please submit a Pull Request. Our executive team will review and confirm your submissions before they are published.