Viindoo Logo

Write Documentation

This guide will help you equip the necessary knowledge to write the documentation.

reStructuredText

The documentation is written in reStructuredText (RST), a lightweight markup language. In the first sight, this language seems abstract with non-technical people. However, RST is not hard to learn, especially if you need to make only small changes to the content.

For a quick RST reference, view our RST cheet sheet.

Getting started

Firstly, you need a GitHub account to be able to make change requests to the documentation. If you haven’t an account yet, create one at here.

Having some ways to make a change request. For non-technical people, we recommend using the GitHub web interface.

Use the GitHub interface