Contributing to the DocsΒΆ

This docs is made with Sphinx (reStructuredText - RST). To be able to contribute and suggest changes, you need to clone the repository locally and have the following dependencies installed:

  1. nanos world Documentation repository.

  2. Python.

  3. Sphynx: pip install -U Sphinx.

  4. Sphynx RTD Theme: pip install sphinx-rtd-theme.

  5. Sphynx extension sphinx-tabs: pip install sphinx-tabs.

Once you have it all installed, you can edit .rst files and create pull requests for your changes to be accepted and included in the main docs ;).

  1. To compile and visualize what you have edited, run on cmd: ./make html, the output files will be located at a _build folder.