Contributing to the documentation

This is the help file to let you know how you could contribute to STW's documentation. To contribute, you will need to understand how the documentation is processed in order to ensure readability, stability, and accuracy.

Syntax

All of the documentation is written using a special syntax called Markdown(.md extention). These Markdown files are then converted into a readable HTML format for display in the browser.

Folder and file structure

Each document is created in each folder. For example, a folder for camera. In the folder, we'll next create index.md. index.md is necessary in each folders you create.

Start

Make sure to clone the repository on your local device.

First of all, look in the docs folders to know how the directories are structured. Only then will you be able to design your documents.

Next, create your document files with .md extention.

Title

The title of the document is used by a first level heading at the top of the file.

# this is the title

The title is simply a first level heading. The top first level heading will be rendered as title of the document.

Heading

Headings are a way to help organize your documentation for readability. A heading is used by a hash character followed by a space(#). The hash character can be added depending on which level of the heading you want. There are 6 available levels. Example

# heading 1
## heading level 2.
#### heading level4.

As you can see, the heading helps organizing your documentation, also offering accessibility for the visually impaired or using keyboard shortcuts.

Code

A code is a block that highlights the code syntax, probably used to show a simple code. A code is used by grave character (`). The grave character is located to the left of number 1 in most keyboards.

Example

# title test

use the command `/help` to game help menu

As you can see, the /help is highlighted as a code

Code block, multi

Sometimes, you may want to show a block of codes with multiple lines. As such time, you can use the syntax below.

The code block is seperated by 3 backticks (```). You may also need to close again. Consider the following example

# title test

Declare y and assign 3-1 to it.

```
y=0
y=3-1;
print(y)
```

You can also add the language name after opening the backticks.

# title test

declare x and add 3+2 in python.

```python
x=3+2
print(x)
```

Paragraph

A paragraph is used by adding 1 line break. Consider the following example

this is the first paragraph

this is another paragraph

Links

You can add links to files or external URLS by surrounding text with left and right bracket, and link with params. Consider the following example

[go to website](https://website.com)

[go to file](file.extention)

[go to the file that is 1 directory upward](../file.extention)

[go to the file from root](/file.extention)

Congratulations!

Thank you for reading all of the help for contributing to documentations. We will cover some fully written examples below.

Example 1

# camera

the camera is an useful thing to navigate and locate the hazards.

Example 2, using 2 files.

Create a new folder called test1 and add index.md into it.

index.md

# index category
* [go to test 1 category](test1)

test1/index.md

# test1 in index.

this is test1 file, documentation