diff --git a/README.md b/README.md index f75eec5..7fd2dc7 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,12 @@ 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 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 +## Runbook 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) +### Dependencies + Install [python3](https://docs.python-guide.org/starting/install3/osx/) Install sphinx and dependencies: @@ -23,11 +17,32 @@ pip3 install sphinx-autobuild pip3 install sphinx-book-theme ``` -run: `sphinx-autobuild source build/html` to activate a live-reload environment on `localhost:8000`. +### 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. + +### Guide Templates + +We welcome contributions to add a guide to this documentation repository. Please follow the templates provided [here](./source/contributing/template) and use proper `rst` style syntax. + +All images should be placed in `./source/_static/images` with descriptive labeling. + +Figure directives should include an alt description. + +### 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. \ No newline at end of file diff --git a/source/_static/images/bengal_cat.jpg b/source/_static/images/bengal_cat.jpg new file mode 100644 index 0000000..97b61d2 Binary files /dev/null and b/source/_static/images/bengal_cat.jpg differ diff --git a/source/_static/images/specter/edit-tor-config1.png b/source/_static/images/specter/edit-tor-config1.png new file mode 100644 index 0000000..66768bc Binary files /dev/null and b/source/_static/images/specter/edit-tor-config1.png differ diff --git a/source/_static/images/specter/embassy1.png b/source/_static/images/specter/embassy1.png new file mode 100644 index 0000000..aec59ce Binary files /dev/null and b/source/_static/images/specter/embassy1.png differ diff --git a/source/_static/images/specter/go-to-folder.png b/source/_static/images/specter/go-to-folder.png new file mode 100644 index 0000000..a8b8706 Binary files /dev/null and b/source/_static/images/specter/go-to-folder.png differ diff --git a/source/_static/images/specter/go-to-folder2.png b/source/_static/images/specter/go-to-folder2.png new file mode 100644 index 0000000..83710aa Binary files /dev/null and b/source/_static/images/specter/go-to-folder2.png differ diff --git a/source/_static/images/specter/install-homebrew.png b/source/_static/images/specter/install-homebrew.png new file mode 100644 index 0000000..ce397f6 Binary files /dev/null and b/source/_static/images/specter/install-homebrew.png differ diff --git a/source/_static/images/specter/install-homebrew1.png b/source/_static/images/specter/install-homebrew1.png new file mode 100644 index 0000000..a896f9b Binary files /dev/null and b/source/_static/images/specter/install-homebrew1.png differ diff --git a/source/_static/images/specter/install_tor.png b/source/_static/images/specter/install_tor.png new file mode 100644 index 0000000..e60ba4c Binary files /dev/null and b/source/_static/images/specter/install_tor.png differ diff --git a/source/_static/images/specter/specter-desktop.png b/source/_static/images/specter/specter-desktop.png new file mode 100644 index 0000000..81550a5 Binary files /dev/null and b/source/_static/images/specter/specter-desktop.png differ diff --git a/source/_static/images/specter/specter-desktop2.png b/source/_static/images/specter/specter-desktop2.png new file mode 100644 index 0000000..f653b1c Binary files /dev/null and b/source/_static/images/specter/specter-desktop2.png differ diff --git a/source/contributing/template.rst b/source/contributing/template.rst new file mode 100644 index 0000000..3cf7494 --- /dev/null +++ b/source/contributing/template.rst @@ -0,0 +1,47 @@ +.. _template: + +.. this is a comment +.. above is how you create an internal link so you can reference this page like :ref:`desired text