Contributing

On this page, we will explain how to contribute to this documentation. This documentation is created using docusaurus, a static-site generator built with react & mdx! You don't need to know anything about React to contribute, only markdown & a little bit of HTML is required!

The repository of this documentation is hosted on github:

You can create a pull request to contribute to the documentation, but be aware that it may be rejected because of the rules! All the rules & tips can be found in this page!

Structure

The documentation is structured into different parts. The only parts that contributors should edit are the following ones: All other files are reserved for the admins from this documentation!

• ./docs/ (documentation)
• ./src/pages/ (extra pages, like this one)
• ./blog/ (the blog)

Here you can find even more info about the different parts:

Sidebar, Titles & Page Structure

Try to follow the style of the other pages when it comes to naming & styling. For Example: only add an emoji if pages in the same category have an emoji!

Don't use heading level 1, 4, 5 & 6 in pages. This is because they don't show up in the table of contents & they are most of the time too large or too small! Here is an example of how a page should look like:

---
title: The Page Title
description: The Page Description
keywords: [keyword_a, keyword_b, keyword_c] //page keywords (SEO)
sidebar_position: 1 //(optional) position in sidebar
---
//import custom components
import {ColorText,LabelText,GoodImage,LinkBlock,InlineLink,FlexHorizontal} from "@site/src/components/openticket.jsx"

//short description of what this page is about
Lorem Ipsum

## First Category \{#custom-id} //the first large heading
Some content here

### Subcategory //a small subcategory
Some extra content here

### Subcategory //a small subcategory
Some extra content here

## Second Category \{#custom-id} //the second large heading
Some content here

### Subcategory //a small subcategory
Some extra content here

### Subcategory //a small subcategory
Some extra content here

## Third Category \{#custom-id} //the third large heading
Some content here

### Subcategory //a small subcategory
Some extra content here

### Subcategory //a small subcategory
Some extra content here

Markdown & Styling

There is a lot of styling available, here we will list some examples! If you want to use one of these examples, check this page out in the github repository!

I'm normal text
I'm bold text
I'm italic text
I'm code text

There are also a lot of colors. They can be created using the <ColorText color="..."> component! Try to use colors in combination with bold text for better visibility!

When displaying large amounts of data, you can use lists & tables like these:

Code Blocks​

There are also code blocks! You can use them to show data with a little bit syntax-highlighting! You can customise the language, title & line numbering!

{
    "abc":123,
    "hey":"Hello World!"
}

//this is coooooool!
const a = 1
const b = 2
const c = a+b
console.log("hello world",c)

ADDED:
+ something cool
+ very small features
+ a rickroll

REMOVED:
- boring stuff
- old stuff

Admonitions​

Admonitions are special notes that deserve extra attention! You can put any other markdown inside of them (so you can see them as a sort of container)

Content & Readability

• ✅ All text on the wiki needs to be in English.
• ✅ Don't make the page to short, but also don't make it to long.
• ✅ Use Admonitions only when really needed! Most of the time, you can also just use colored text!
• ✅ Check your text for grammatical errors before uploading!
• ✅ When you write an article in the blog, make sure it's linked to your name!

And thats it! For more questions, visit our discord server!