From fb5a36309606c9ec128a4439468163101c842bbd Mon Sep 17 00:00:00 2001 From: Lucy Cifferello <12953208+elvece@users.noreply.github.com> Date: Mon, 20 Dec 2021 11:36:52 -0700 Subject: [PATCH] rename docs folder to site --- .gitignore | 2 - README.md | 4 +- poetry.lock | 6 +-- site/source/index.rst | 107 +++++++++++++++++------------------------- 4 files changed, 49 insertions(+), 70 deletions(-) diff --git a/.gitignore b/.gitignore index defb084..c89111e 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,4 @@ .vscode/ build-send.sh site/_build -site/_utils/docsearch_config.json -site/_utils/docsearch_index.js .env \ No newline at end of file diff --git a/README.md b/README.md index ac53988..cf264ac 100644 --- a/README.md +++ b/README.md @@ -42,10 +42,10 @@ git clone https://github.com/Start9Labs/documentation.git && cd documentation git submodule update --init ``` -1. Navigate to the `docs` folder and start the project: +1. Navigate to the `site` folder and start the project: ``` -cd docs +cd site make clean && make preview ``` ## Development diff --git a/poetry.lock b/poetry.lock index dd849f0..1018e3c 100644 --- a/poetry.lock +++ b/poetry.lock @@ -126,7 +126,7 @@ python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" [[package]] name = "importlib-metadata" -version = "4.9.0" +version = "4.10.0" description = "Read metadata from Python packages" category = "dev" optional = false @@ -673,8 +673,8 @@ imagesize = [ {file = "imagesize-1.3.0.tar.gz", hash = "sha256:cd1750d452385ca327479d45b64d9c7729ecf0b3969a58148298c77092261f9d"}, ] importlib-metadata = [ - {file = "importlib_metadata-4.9.0-py3-none-any.whl", hash = "sha256:e8b45564028bc25f8c99f546616112a6df5de6655893d7eb74c9a99680dc9751"}, - {file = "importlib_metadata-4.9.0.tar.gz", hash = "sha256:ee50794eccb0ec340adbc838344ebb9a6ff2bcba78f752d31fc716497e2149d6"}, + {file = "importlib_metadata-4.10.0-py3-none-any.whl", hash = "sha256:b7cf7d3fef75f1e4c80a96ca660efbd51473d7e8f39b5ab9210febc7809012a4"}, + {file = "importlib_metadata-4.10.0.tar.gz", hash = "sha256:92a8b58ce734b2a4494878e0ecf7d79ccd7a128b5fc6014c401e0b61f006f0f6"}, ] jinja2 = [ {file = "Jinja2-3.0.3-py3-none-any.whl", hash = "sha256:077ce6014f7b40d03b47d1f1ca4b0fc8328a692bd284016f806ed0eaca390ad8"}, diff --git a/site/source/index.rst b/site/source/index.rst index 8c26c6d..2899757 100644 --- a/site/source/index.rst +++ b/site/source/index.rst @@ -5,8 +5,11 @@
.. hero-box:: - :title: Documentation + :title: Welcome to the Start9 Documentation :button_icon: scylla-icon scylla-icon--monitoring + :button_url: user-manual + :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. @@ -21,94 +24,72 @@
.. topic-box:: - :title: Getting Started - :link: getting-started - :icon: scylla-icon scylla-icon--knowledge-base + :title: Purchasing + :link: user-manual/getting-started/purchasing + :icon: scylla-icon scylla-icon--bitcoin :class: large-6 - :anchor: Begin + :anchor: Learn more - Dive into the Embassy documentation and other helpful guides + Learn about how you can purchase Start9 products. .. topic-box:: - :title: User Manual - :link: user-manual - :icon: scylla-icon scylla-icon--integrations + :title: Videos + :link: https://www.youtube.com/channel/UCGEw4HJDvOn3Oy8ykR36P7Q + :icon: scylla-icon scylla-icon--webinars :class: large-6 - :anchor: View + :anchor: Learn more - Get started with learning how to use EmbassyOS - -.. topic-box:: - :title: Misc Guides - :link: misc-guides - :icon: scylla-icon scylla-icon--docs - :class: large-6 - :anchor: View - - Setup your devices and Embassy for better connectivity and performance + Check out our how to and informational videos. .. topic-box:: :title: Support - :link: support + :link: knowledge-base/faq :icon: scylla-icon scylla-icon--support :class: large-6 - :anchor: Get help + :anchor: Learn more - Learn about or troubleshoot your Embassy + Read our FAQ and learn about platform concepts. + +.. topic-box:: + :title: DIY + :link: user-manual/tuning/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 + :link: dev-docs/dev-faq/faq-contributing :icon: scylla-icon scylla-icon--apps :class: large-6 - :anchor: Get started + :anchor: Learn more - Use your skills to add to the Start9 ecosystem + Learn about developing for EmbassyOS or contribute to packing services for the marketplace. -.. topic-box:: - :title: FAQ - :link: support/FAQ - :icon: scylla-icon scylla-icon--search - :class: large-6 - :anchor: Get answers +.. raw:: html - Find answers to common questions +
-.. .. topic-box:: -.. :title: Learn -.. :link: support/FAQ -.. :icon: scylla-icon scylla-icon--webinars -.. :class: large-6 -.. :anchor: Get started - -.. Read our FAQ and learn about platform concepts - -.. .. topic-box:: -.. :title: Purchasing -.. :link: https://store.start9.com -.. :icon: scylla-icon scylla-icon--bitcoin -.. :class: large-4 -.. :anchor: Buy now - -.. Learn about how you can purchase Start9 products - -.. .. topic-box:: -.. :title: Build your own -.. :link: user-manual/tuning/diy -.. :icon: scylla-icon scylla-icon--integrations -.. :class: large-4 -.. :anchor: Get started - -.. Build from source with our DIY guide +.. raw:: html + .. This is for the side navigation display .. toctree:: :maxdepth: 2 :hidden: - getting-started/index user-manual/index - misc-guides/index - contributing/index - support/index + knowledge-base/index + dev-docs/index \ No newline at end of file