restructure to account for new theme, add new build process, update readme

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "sphinx-scylladb-theme"]
+	path = sphinx-scylladb-theme
+	url = https://github.com/Start9Labs/sphinx-scylladb-theme.git

Makefile

@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = source
-BUILDDIR      = build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

README.md

@@ -2,41 +2,44 @@
 
 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
+## Toolkit
 
-This project uses:
+These are the basic tools this project uses:
-- [Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html)
-- [Restructured Text](https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html)
-- [Sphinx Book Theme](https://sphinx-book-theme.readthedocs.io/)
 
-### Dependencies
+### Markup language
 
-Install [python3](https://docs.python-guide.org/starting/install3/osx/)
+Docs are written in [RestructuredText](https://www.sphinx-doc.org/es/master/usage/restructuredtext/index.html). RestructuredText is a file format for textual data used primarily for technical documentation.
 
-Install sphinx and dependencies:
+### Sphinx
-```
-brew install sphinx-doc
-pip3 install sphinx-autobuild
-pip3 install sphinx-book-theme || pip install git+https://github.com/executablebooks/sphinx-book-theme.git@master
-pip3 install sphinxcontrib.yt
-pip3 install sphinx-multiversion
-```
 
-### Development
+The tool we used to converts [restructuredText](https://www.sphinx-doc.org) and Markdown to HTML.
+Sphinx also has directives and extensions to add additional options for formatting the text.
 
-Run: `sphinx-autobuild source build/html` to activate a live-reload environment on `localhost:8000`.
+### Scylla Sphinx Theme
 
-To run in development mode when actively changing js/css files run: `sphinx-autobuild source build/html source/_static/js/main.js source/_static/default.css`. This will auto reload with changes to noted files.
+A customized version of the [theme](https://github.com/scylladb/sphinx-scylladb-theme) used by Scylla documentation projects. It also adds a set of custom functionalities and styles.
 
-The main configuration file for this project is located at `./source/conf.py`.
+### Multiversion extension
 
-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.
+The [extension](https://github.com/Holzhaus/sphinx-multiversion) used to build docs for different versions.
 
-If any css or table of contents organization changes, run: `make clean html`.
+## Dependencies
+
+Install [pyenv](https://github.com/pyenv/pyenv)
+
+## Development
+
+When editing these files, begin a livereload environment by running `make preview` while in the `./docs/` directory.
+
+When editing any css or table of contents organization changes, the livereload environment must be ended and `make clean` run before starting `make preview` again.
+
+### Versioning
+- Build for versioning (must be on master) branch: `make multiversion`
+- To view version metadata: `make multiversionpreview`
 
 ## 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.
+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 <https://github.com/Start9Labs/documentation/issues>`__ .
 
 ### Submitting an issue
 
@@ -44,21 +47,13 @@ Click on the "Issues" tab in the top navbar. Provide a good title and describe c
 
 ### 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.
+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. 
 
 ## Helpful Resources
 
-- [Lists in RST](https://sublime-and-sphinx-guide.readthedocs.io/en/latest/lists.html)
+### Sphinx and RST syntax guides:
-
+http://sphinx-doc.org/rest.html
-## Updating theme
+http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
-
+http://www.siafoo.net/help/reST
-To update Sphinx Book Theme:
+http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html
-- `pip uninstall sphinx-book-theme` (needed to properly propagate new changes for some undetermined reason)
+https://sublime-and-sphinx-guide.readthedocs.io/en/latest/lists.html
-- `pip install sphinx-book-theme==<tag_version>` || `pip install git+https://github.com/executablebooks/sphinx-book-theme.git@<branch_name>` eg. `pip install sphinx-book-theme==0.0.42`
-
-To deploy theme update:
-- Build and publish according to production release process
-
-## Versioning
-- Build for versioning: `sphinx-multiversion source build/html`
-- To view version metadata: `sphinx-multiversion source build/html --dump-metadata`

docs/Makefile

@@ -0,0 +1,86 @@
+# You can set these variables from the command line.
+POETRY        = $(HOME)/.poetry/bin/poetry
+SPHINXOPTS    = -j auto
+SPHINXBUILD   = $(POETRY) run sphinx-build
+PAPER         =
+BUILDDIR      = _build
+SOURCEDIR     = source
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
+TESTSPHINXOPTS  = $(ALLSPHINXOPTS) -W --keep-going
+
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
+
+.PHONY: all
+all: dirhtml
+
+.PHONY: pristine
+pristine: clean
+	git clean -dfX
+
+.PHONY: setup
+setup:
+	./_utils/setup.sh
+
+.PHONY: clean
+clean:
+	rm -rf $(BUILDDIR)/*
+
+.PHONY: preview
+preview: setup
+	$(POETRY) run sphinx-autobuild -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml --port 5500
+
+.PHONY: dirhtml
+dirhtml: setup
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+.PHONY: singlehtml
+singlehtml: setup
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+.PHONY: test
+test: setup
+	$(SPHINXBUILD) -b dirhtml $(TESTSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+.PHONY: epub
+epub: 	setup
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+.PHONY: epub3
+epub3:	setup
+	$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
+	@echo
+	@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
+
+.PHONY: dummy
+dummy: 	setup
+	$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
+	@echo
+	@echo "Build finished. Dummy builder generates no files."
+
+.PHONY: linkcheck
+linkcheck: setup
+	$(SPHINXBUILD) -b linkcheck $(SOURCEDIR) $(BUILDDIR)/linkcheck
+
+.PHONY: multiversion
+multiversion: setup
+	@mkdir -p $(HOME)/.cache/pypoetry/virtualenvs
+	$(POETRY) run sphinx-multiversion source $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+.PHONY: multiversionpreview
+multiversionpreview: multiversion
+	$(POETRY) run python3 -m http.server 5500 --directory $(BUILDDIR)/dirhtml

docs/_build/dirhtml/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 08addde01d713beb7fdd9a5fa8fa3bb9
+tags: d77d1c0d9ca2f4c8421862c7c5a0d620

docs/_build/dirhtml/404.html

@@ -0,0 +1,36 @@
+
+
+<!DOCTYPE html>
+<html class="no-js height" lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width initial-scale=1" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+
+    <title>Start9</title>
+    <meta name="description" content="Start9 Product Documentation and Education Guides" />
+    <link rel="icon" src="/_static/img/favicon.ico" type="image/x-icon" />
+    <link rel="preconnect" href="https://fonts.gstatic.com" />
+    <link
+      href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,400;0,500;0,700;1,400&display=swap"
+      rel="stylesheet"
+    />
+
+    <link rel="stylesheet" href="/_static/css/main.css" type="text/css" />
+    <link
+      rel="stylesheet"
+      href="/en/latest/_static/css/main.css"
+      type="text/css"
+    />
+  </head>
+  <body class="not-found">
+    <img class="not-found__icon" src="/_static/img/404.jpg" alt="" />
+    <div class="not-found__text">
+      <h1>404</h1>
+      <p>We cannot find what you are looking for!</p>
+      <p>
+        <a href="https://docs.start9.com" class="button not-found__button">Home</a>
+      </p>
+    </div>
+  </body>
+</html>

docs/_build/dirhtml/404/index.html

@@ -0,0 +1,36 @@
+
+
+<!DOCTYPE html>
+<html class="no-js height" lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width initial-scale=1" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+
+    <title>Start9</title>
+    <meta name="description" content="Start9 Product Documentation and Education Guides" />
+    <link rel="icon" src="/_static/img/favicon.ico" type="image/x-icon" />
+    <link rel="preconnect" href="https://fonts.gstatic.com" />
+    <link
+      href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,400;0,500;0,700;1,400&display=swap"
+      rel="stylesheet"
+    />
+
+    <link rel="stylesheet" href="/_static/css/main.css" type="text/css" />
+    <link
+      rel="stylesheet"
+      href="/en/latest/_static/css/main.css"
+      type="text/css"
+    />
+  </head>
+  <body class="not-found">
+    <img class="not-found__icon" src="/_static/img/404.jpg" alt="" />
+    <div class="not-found__text">
+      <h1>404</h1>
+      <p>We cannot find what you are looking for!</p>
+      <p>
+        <a href="https://docs.start9.com" class="button not-found__button">Home</a>
+      </p>
+    </div>
+  </body>
+</html>

docs/_build/dirhtml/_sources/index.rst.txt

@@ -0,0 +1,132 @@
+.. title:: Start9 Documentation
+
+.. raw:: html
+
+  <div class="landing landing--floating">
+
+.. hero-box::
+  :title: Welcome to the Start9 Documentation
+  :button_icon: scylla-icon scylla-icon--monitoring
+  :button_url: https://docs.start9.com/getting-started/introduction/
+  :button_text: Start here
+  :image: /_static/img/icons/docs_info.png
+
+  Here you will find guidance and information about the Start9 Embassy personal server and its operating system, EmbassyOS.
+
+.. raw:: html
+
+  <div class="landing__content landing__content">
+
+.. raw:: html
+
+  <div class="topics-grid grid-container full">
+
+  <div class="grid-x grid-margin-x">
+
+.. topic-box::
+  :title: Purchasing
+  :link:   getting-started/purchasing
+  :icon: scylla-icon scylla-icon--bitcoin
+  :class: large-6
+  :anchor: Learn more
+
+  Learn about how you can purchase Start9 products.
+
+.. topic-box::
+  :title: Videos
+  :link: https://www.youtube.com/channel/UCGEw4HJDvOn3Oy8ykR36P7Q
+  :icon: scylla-icon scylla-icon--webinars
+  :class: large-6
+  :anchor: Learn more
+
+  Check out our how to and informational videos.
+
+.. topic-box::
+  :title: Support
+  :link: support
+  :icon: scylla-icon scylla-icon--support
+  :class: large-6
+  :anchor: Learn more
+
+  Read our FAQ and learn about platform concepts.
+
+.. topic-box::
+  :title: DIY
+  :link: getting-started/diy
+  :icon: scylla-icon scylla-icon--integrations
+  :class: large-6
+  :anchor: Learn more
+
+  Get started yourself with our Do It Yourself guide
+
+.. topic-box::
+  :title: About
+  :link: about
+  :icon: scylla-icon scylla-icon--about-team
+  :class: large-6
+  :anchor: Learn more
+
+  Explore Start9's mission and philosophy.
+
+.. topic-box::
+  :title: Contribute
+  :link: contributing
+  :icon: scylla-icon scylla-icon--apps
+  :class: large-6
+  :anchor: Learn more
+
+  Learn about developing for EmbassyOS or contribute to packing services for the marketplace.
+
+.. raw:: html
+
+  </div></div>
+
+.. raw:: html
+
+  </div></div>
+
+.. toctree::
+  :maxdepth: 2
+  :caption: Getting Started
+  :hidden:
+
+  getting-started/introduction
+  getting-started/purchasing
+  getting-started/diy
+
+.. toctree::
+  :maxdepth: 2
+  :caption: User Manual
+  :hidden:
+
+  user-manual/initial-setup
+  user-manual/connecting
+  user-manual/general/index
+  user-manual/managing-services/index
+
+.. toctree::
+  :maxdepth: 2
+  :caption: Misc Guides
+  :hidden:
+
+  misc-guides/available-services
+  misc-guides/bitcoin-cli
+  misc-guides/tor-os/index
+  misc-guides/tor-firefox/index
+
+.. toctree::
+  :maxdepth: 2
+  :caption: Contributing
+  :hidden:
+
+  contributing/services/index
+  contributing/embassyos
+
+.. toctree::
+  :maxdepth: 2
+  :caption: Support
+  :hidden:
+
+  support/FAQ/index
+  support/concepts
+  support/contact