Note
This article is about contributing pages and edits to this wiki.
You can fork this documentation from the MAD-docs GitHub repository and open pull requests for changes.
A few guidelines to help keep things clean and organized...
Keep filenames short and to the point, for example: installation.rst
Always begin your new page with a title:
Awesome Wiki Page
################Titles will be shown at the top of a page and in the site navigation. A title should describe a page in a glance. The rest of the file is written in ReST or Markdown structured text. Here is a cheatsheet for RST formatting, and one for markdown.
Once done editing your page, add it under one of the toctree sections in index.rst.
This wiki is using Sphinx to render it to html. Install python, and these pip packages to test the wiki locally: sphinx, recommonmark, sphinx_rtd_theme.
Now to preview your changes, open a terminal and use make html. This will generates html files in _build/html/. You can see the final documentation by opening them up with a browser.
Finally, when you are finished, submit your changes as a Pull Request to be reviewed.