Start9 Labs Documentation

At Start9, we see great value in maintaining clear and accurate documentation for our already simple and friendly products. These docs are a continuous work-in-progress, and we welcome contributions from our partners and customers.

Runbook

This project uses Sphinx and Restructured Text

Dependencies

Install python3

Install sphinx and dependencies:

brew install sphinx-doc
pip3 install sphinx-autobuild
pip3 install sphinx-book-theme

Development

Run: sphinx-autobuild source build/html to activate a live-reload environment on localhost:8000.

The main configuration file for this project is located at ./source/conf.py.

The navigation structure is aligned with the folder/file organization under ./source/. This is where the individual page .rst files live and can be edited.

If any css or table of contents organization changes, run: make clean html.

Contributing to the docs

If you notice a mistake in the docs, or you have an idea for improving them, we would like to know about it. You can either fix the mistake yourself and submit a pull request, or you can report the mistake by submitting an issue.

Submitting an issue

Click on the "Issues" tab in the top navbar. Provide a good title and describe clearly the mistake or improvement.

Submitting a pull request

Click on the "Pull requests" tab in the top navbar. Select the green "New pull request button" in the top right section. Select your branch for the compare dropdown, and master as the base. Provide an appropriate title and summary of the changes in the pull request description. Changes will be reviewed and merged when satisfactory.