Update docs to reflect new organization.

Reboot-Codes · Sep 1, 2024 · 7d3d1f2 · 7d3d1f2
1 parent d249f8d
commit 7d3d1f2
Show file tree

Hide file tree

Showing 19 changed files with 64 additions and 6 deletions.
diff --git a/docs/docs/CORE/_category_.yaml b/docs/docs/CORE/_category_.yaml
@@ -0,0 +1,3 @@
+link:
+  type: doc
+  id: intro
diff --git a/docs/docs/CORE/intro.md b/docs/docs/CORE/intro.md
@@ -0,0 +1,5 @@
+# CORE
+
+Central Organizational Robotic Extremities
+
+The default modules, applications, and expression packs for CLOVER.
diff --git a/docs/docs/clover-hub/server/appd/_category_.yaml b/docs/docs/clover-hub/server/appd/_category_.yaml
@@ -0,0 +1,3 @@
+link:
+  type: doc
+  id: intro
diff --git a/docs/docs/clover-hub/server/appd/intro.md b/docs/docs/clover-hub/server/appd/intro.md
@@ -0,0 +1,5 @@
+# AppDaemon
+
+Manage containerized applications.
+
+Runs all applications through Docker/Podman in a managed, containerized manner to ensure security.
diff --git a/docs/docs/clover-hub/server/arbiter/_category_.yaml b/docs/docs/clover-hub/server/arbiter/_category_.yaml
@@ -0,0 +1,3 @@
+link:
+  type: doc
+  id: intro
diff --git a/docs/docs/clover-hub/server/arbiter/intro.md b/docs/docs/clover-hub/server/arbiter/intro.md
@@ -0,0 +1,3 @@
+# Arbiter
+
+Permission model and authentication root of trust.
diff --git a/docs/docs/clover-hub/server/evtbuzz/_category_.yaml b/docs/docs/clover-hub/server/evtbuzz/_category_.yaml
@@ -0,0 +1,3 @@
+link:
+  type: doc
+  id: intro
diff --git a/docs/docs/clover-hub/server/auth.md → docs/docs/clover-hub/server/evtbuzz/auth.md b/docs/docs/clover-hub/server/auth.md → docs/docs/clover-hub/server/evtbuzz/auth.md
diff --git a/docs/docs/clover-hub/server/events.md → .../docs/clover-hub/server/evtbuzz/events.md b/docs/docs/clover-hub/server/events.md → .../docs/clover-hub/server/evtbuzz/events.md
diff --git a/docs/docs/clover-hub/server/evtbuzz/intro.md b/docs/docs/clover-hub/server/evtbuzz/intro.md
@@ -0,0 +1,3 @@
+# EVTBuzz
+
+The main API and WS event server for Clover. Everything runs through here in some way.
diff --git a/docs/docs/clover-hub/server/inference-engine/_category_.yaml b/docs/docs/clover-hub/server/inference-engine/_category_.yaml
@@ -0,0 +1,3 @@
+link:
+  type: doc
+  id: intro
diff --git a/docs/docs/clover-hub/server/inference-engine/intro.md b/docs/docs/clover-hub/server/inference-engine/intro.md
@@ -0,0 +1,3 @@
+# InferenceEngine
+
+TPU manager for Machine Learning models.
diff --git a/docs/docs/clover-hub/server/intro.md b/docs/docs/clover-hub/server/intro.md
@@ -1,3 +1,11 @@
 # Server
 
-The CloverHub server runs, by default, on port 6699 (yes, you can say "nice", this was intentional), and provides a standardized, secure, websocket-based event bus for all of clover's components to use.
+The CloverHub server (specifically, EVTBuzz) runs, by default, on port 6699 (yes, you can say "nice", this was intentional), and provides a standardized, secure, websocket-based event bus for all of clover's components to use.
+
+CloverHub also contains a bunch of extra stuff like:
+
+- Arbiter: Permission model and authentication root of trust.
+- Renderer: Output independent, 2.5D UI renderer.
+- InferenceEngine: TPU manager for Machine Learning models.
+- ModMan: Manage module registration and user configuration.
+- AppDaemon (a.k.a. AppD): Manage containerized applications.
diff --git a/docs/docs/clover-hub/server/modman/_category_.yaml b/docs/docs/clover-hub/server/modman/_category_.yaml
@@ -0,0 +1,3 @@
+link:
+  type: doc
+  id: intro
diff --git a/docs/docs/clover-hub/server/modman/intro.md b/docs/docs/clover-hub/server/modman/intro.md
@@ -0,0 +1,3 @@
+# ModMan
+
+Manage module registration and user configuration.
diff --git a/docs/docs/clover-hub/server/renderer/_category_.yaml b/docs/docs/clover-hub/server/renderer/_category_.yaml
@@ -0,0 +1,3 @@
+link:
+  type: doc
+  id: intro
diff --git a/docs/docs/clover-hub/server/renderer/intro.md b/docs/docs/clover-hub/server/renderer/intro.md
@@ -0,0 +1,3 @@
+# Renderer
+
+Output independent, 2.5D UI renderer.
diff --git a/docs/docs/intro.md b/docs/docs/intro.md
@@ -2,9 +2,13 @@
 sidebar_position: 1
 ---
 
-# Introduction to Clover
+# Introduction to CLOVER
 
-Smart fursuit parts made for daily wear to help out your species dysphoria.
+CLOVER stands for:
+
+> Cybernetic Living Organism Variable Extension Regulator
+
+Or, tl;dr, smart fursuit parts made for daily wear to help out your species dysphoria.
 
 Reads your expressions to change the position and display of animatronic fursuit parts, such as a head (with ears, a maw, and a custom LED display), tail, and paws. 
 

diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx
@@ -20,7 +20,7 @@ function HomepageHeader() {
           <Link
             className="button button--secondary button--lg"
             to="/docs/intro">
-            Docusaurus Tutorial - 5min ⏱️
+            Get Started
           </Link>
         </div>
       </div>
@@ -32,8 +32,8 @@ export default function Home(): JSX.Element {
   const {siteConfig} = useDocusaurusContext();
   return (
     <Layout
-      title={`Hello from ${siteConfig.title}`}
-      description="Description will go into a meta tag in <head />">
+      title={siteConfig.title}
+      description={siteConfig.tagline}>
       <HomepageHeader />
       <main>
         <HomepageFeatures />
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Arbiter

		Permission model and authentication root of trust.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# EVTBuzz

		The main API and WS event server for Clover. Everything runs through here in some way.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# InferenceEngine

		TPU manager for Machine Learning models.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# ModMan

		Manage module registration and user configuration.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Renderer

		Output independent, 2.5D UI renderer.