new docs structure

OpenInterpreter · Mar 13, 2024 · 7d5e0b0 · 7d5e0b0
1 parent cb3601e
commit 7d5e0b0
Show file tree

Hide file tree

Showing 18 changed files with 83 additions and 312 deletions.
diff --git a/docs/01os/01os-settings.mdx b/docs/01os/01os-settings.mdx
diff --git a/docs/01os/environment-variables.mdx b/docs/01os/environment-variables.mdx
diff --git a/docs/bodies/01-heavy.mdx b/docs/bodies/01-heavy.mdx
@@ -0,0 +1,6 @@
+---
+title: "01 Heavy"
+description: "Build your 01 Heavy"
+---
+
+runs fully locally + coming soon
diff --git a/docs/bodies/01-light.mdx b/docs/bodies/01-light.mdx
@@ -0,0 +1,6 @@
+---
+title: "01 Light"
+description: "Build your 01 Light"
+---
+
+01 Light (one pager that points to the STL, wiring diagrams, and points to the ESP32 client setup page^)
diff --git a/docs/client/setup.mdx b/docs/client/setup.mdx
@@ -0,0 +1,9 @@
+---
+title: "Setup"
+description: "Get your 01 client up and running"
+---
+
+(lets you pick from a grid of avaliable clients)
+
+- ESP32 (instructions for flashing it)
+- Desktop (basically says "just run start.py with no args, that will run the server with a client, or start.py --client to just run the client")
diff --git a/docs/introduction.mdx → docs/getting-started/introduction.mdx b/docs/introduction.mdx → docs/getting-started/introduction.mdx
@@ -3,6 +3,10 @@ title: Introduction
 description: "The 01 is a Language Model Computer. 01OS is its operating system"
 ---
 
+Introduction (the what, ripped from the github) — same as OI, I think should have a very basic setup on the bottom of that page, just about cloning the repo and running start.py.
+
+** PREVIOUS **
+
 <img
   src="https://openinterpreter.com/assets/banner.jpg"
   alt="thumbnail"

diff --git a/docs/getting-started/setup.mdx b/docs/getting-started/setup.mdx
@@ -0,0 +1,6 @@
+---
+title: "Setup"
+description: "Get your 01 up and running"
+---
+
+Setup (breaks down the basic steps of the following and links to the pages for more info)
diff --git a/docs/guides/hardware.mdx b/docs/guides/hardware.mdx
diff --git a/docs/guides/software.mdx b/docs/guides/software.mdx
diff --git a/docs/guides/teach.mdx b/docs/guides/teach.mdx
diff --git a/docs/mint.json b/docs/mint.json
@@ -21,7 +21,7 @@
   "topbarLinks": [
     {
       "name": "GitHub",
-      "url": "https://github.com/KillianLucas/01"
+      "url": "https://github.com/OpenInterpreter/01"
     }
   ],
   "topbarCtaButton": {
@@ -34,22 +34,27 @@
   "navigation": [
     {
       "group": "Getting Started",
-      "pages": ["introduction", "setup"]
+      "pages": ["getting-started/introduction", "getting-started/setup"]
     },
     {
-      "group": "Guides",
-      "pages": ["guides/hardware", "guides/software", "guides/teach"]
+      "group": "Server",
+      "pages": ["server/setup"]
     },
     {
-      "group": "01OS",
-      "pages": ["01os/01os-settings", "01os/environment-variables"]
-    },
-    {
-      "group": "Technical",
+      "group": "Services",
       "pages": [
-        "technical-instructions/development",
-        "technical-instructions/build-hardware"
+        "services/language-model",
+        "services/speech-to-text",
+        "services/text-to-speech"
       ]
+    },
+    {
+      "group": "Client",
+      "pages": ["client/setup"]
+    },
+    {
+      "group": "Bodies",
+      "pages": ["bodies/01-light", "bodies/01-heavy"]
     }
   ],
   "feedback": {

diff --git a/docs/server/setup.mdx b/docs/server/setup.mdx
@@ -0,0 +1,11 @@
+---
+title: "Setup"
+description: "Get your 01 server up and running"
+---
+
+Setup (just run start.py --server , explain the flags (revealed via start.py --help))
+
+- Interpreter
+  - Open Interpreter (explains i.py, how you configure your interpreter, cover the basic settings of OI (that file is literally just modifying an interpreter from OI)
+  - Language Model (LLM setup via interpreter.model in i.py or from the command line via start.py --server --llm-service llamafile)
+- Voice Interface (explains that you can run --tts-service and --stt-service to swap out for different services, which are in /Services/Speech-to-text and /Services/Text-to-text)
diff --git a/docs/services/language-model.mdx b/docs/services/language-model.mdx
@@ -0,0 +1,9 @@
+---
+title: "Language Model"
+description: "The LLM that powers your 01"
+---
+
+- Llamafile (Local)
+- Llamaedge (Local)
+- Hosted Models (explains that we use litellm, you can pass in many different model flags to this)
+- Add more (placeholder, we will add instructions soon)
diff --git a/docs/services/speech-to-text.mdx b/docs/services/speech-to-text.mdx
@@ -0,0 +1,8 @@
+---
+title: "Speech To Text"
+description: "Converts your voice into text"
+---
+
+- Whisper (Local)
+- Whisper (Hosted)
+- Add more (placeholder, we will add instructions soon)
diff --git a/docs/services/text-to-speech.mdx b/docs/services/text-to-speech.mdx
@@ -0,0 +1,8 @@
+---
+title: "Text To Speech"
+description: "Converts the text into audio"
+---
+
+- Piper (Local)
+- OpenAI (Hosted)
+- Add more (placeholder, we will add instructions soon)
diff --git a/docs/setup.mdx b/docs/setup.mdx