SFU Open-source Development Club
Docusauraus Documentation Tool

What is this? • Purpose of this tool • How to contribute

What is this?

This SFU OS Dev Documentation tool is built using Docusaurus, a modern static website generator and hosted by Github Page.

Click here to go to our Documentation

Purpose of this tool

We invite you to contribute to the SFU OS Development Club's Documentation page, designed to support current and future students in Computer Science, Software Systems, Computer Engineering, and Computer Science minors, as well as anyone interested in starting their journey in Computer Science. Our goal is to provide valuable resources that will help individuals excel in group projects and stay ahead in their academic and professional endeavors.

Thank you for your contributions and continued support!

How to contribute

All the documentation needs to be done in markdown format and upload it to docs folder.

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

---
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:

---
sidebar_position: 2
---

and have to add _category_.json file in the folder. The _category_.json file should look like this:

{
  "label": "Git Documentation",
  "position": 1,
  "link": {
    "type": "generated-index"
  }
}

The format will look as this:

── git-folder/
│   ├── _catagory_.json
│   ├── readme1.md
│   ├── readme2.md
│   ├── readme3.md
│   ├── readme4.md

After that process, you need to add your section in sidebars.ts in order to display in documentation section.

tutorialSidebar: [
  "intro",
  {
    type: "category",
    label: "WSL Installation",
    items: [
      "tutorial-wsl/sfu-vpn",
      "tutorial-wsl/why-wsl",
      "tutorial-wsl/wsl-installation_Windows",
      "tutorial-wsl/wsl-installation_macOS",
    ],
  },
];

To contribute, please submit a Pull Request. Our executive team will review and confirm your submissions before they are published.

Thank you for your contribution!