diff --git a/README.md b/README.md index 7c1174e..1dc27c9 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,33 @@ # Start9 Labs Documentation -## Environment Setup +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. + +## 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 submittig 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 + +This project uses [Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html) and [Restructured Text](https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html) Install [python3](https://docs.python-guide.org/starting/install3/osx/) -Install sphinx: `brew install sphinx-doc` - -Python dependencies: +Install sphinx and dependencies: ``` +brew install sphinx-doc pip3 install sphinx-autobuild pip3 install sphinx-book-theme ``` -## To Develop +run: `sphinx-autobuild source build/html` to activate a live-reload environment on `localhost:8000`. -This project uses [Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html) and [Restructured Text](https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html) -`./source/conf.py` is the configuration source for the Sphinx project. +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` - -To activate a live-reload environment on `localhost:8000`, run: `sphinx-autobuild source build/html` \ No newline at end of file +If any css or table of contents organization changes, run: `make clean html`.