Skip to content
Snippets Groups Projects
README.md 762 B
Newer Older
Alice Poggioli's avatar
Alice Poggioli committed
# The main documentation

This is the repository of [the main documentation of Startin'blox](https://docs.startinblox.com/).

We use [Sphinx](https://www.sphinx-doc.org/en/master/) to manage the documentation and we use [Restructured Text](https://docutils.sourceforge.io/rst.html) to write it.

Alice Poggioli's avatar
Alice Poggioli committed
[Why we've chosen Restructured Text](https://www.ericholscher.com/blog/2016/mar/15/dont-use-markdown-for-technical-docs/)
Alice Poggioli's avatar
Alice Poggioli committed

## How to update it

Alice Poggioli's avatar
Alice Poggioli committed
 * Clone the repository
Alice Poggioli's avatar
Alice Poggioli committed
 * Find the file you want to update and make your change
Alice Poggioli's avatar
Alice Poggioli committed
 * Make a Merge Request and assign Alice Poggioli :)
Alice Poggioli's avatar
Alice Poggioli committed

## You get trouble ?

If you have any difficulties or feedbacks, we'll be pleased to improve the doc thanks to your contribution !

Contact the maintainer : alice@startinblox.com

Thanks!