Update documentation to include new Livekit and Light server setup guides, remove outdated run guide, and reflect changes to 01 platform introduction and hardware documentation.

pull/299/head
Mike Bird 5 months ago
parent f0037fba37
commit dad2c37395

@ -9,7 +9,7 @@ description: "The open-source language model computer"
style={{ transform: "translateY(-1.25rem)" }} style={{ transform: "translateY(-1.25rem)" }}
/> />
The **01** is an open-source platform for conversational devices, inspired by the *Star Trek* computer. The **01** is an open-source platform for conversational devices, inspired by the _Star Trek_ computer.
With [Open Interpreter](https://github.com/OpenInterpreter/open-interpreter) at its core, the **01** is more natural, flexible, and capable than its predecessors. Assistants built on **01** can: With [Open Interpreter](https://github.com/OpenInterpreter/open-interpreter) at its core, the **01** is more natural, flexible, and capable than its predecessors. Assistants built on **01** can:
@ -19,7 +19,7 @@ With [Open Interpreter](https://github.com/OpenInterpreter/open-interpreter) at
- Control third-party software - Control third-party software
- ... - ...
<br> <br></br>
We intend to become the GNU/Linux of this space by staying open, modular, and free. We intend to become the GNU/Linux of this space by staying open, modular, and free.

@ -6,5 +6,3 @@ description: "The 01 light"
The 01 light is an open-source voice interface. The 01 light is an open-source voice interface.
The first body was designed to be push-to-talk and handheld, but the core chip can be built into standalone bodies with hardcoded wifi credentials. The first body was designed to be push-to-talk and handheld, but the core chip can be built into standalone bodies with hardcoded wifi credentials.
[MORE COMING SOON]

@ -44,7 +44,8 @@
"pages": [ "pages": [
"software/introduction", "software/introduction",
"software/installation", "software/installation",
"software/run", "software/livekit-server",
"software/light-server",
"software/configure", "software/configure",
"software/flags" "software/flags"
] ]
@ -55,6 +56,7 @@
{ {
"group": "01 Light", "group": "01 Light",
"pages": [ "pages": [
"hardware/01-light/introduction",
"hardware/01-light/materials", "hardware/01-light/materials",
"hardware/01-light/case", "hardware/01-light/case",
"hardware/01-light/assembly", "hardware/01-light/assembly",
@ -66,17 +68,25 @@
"hardware/desktop", "hardware/desktop",
{ {
"group": "Mobile", "group": "Mobile",
"pages": ["hardware/mobile/ios", "hardware/mobile/android", "hardware/mobile/privacy"] "pages": [
"hardware/mobile/ios",
"hardware/mobile/android",
"hardware/mobile/privacy"
]
} }
] ]
}, },
{ {
"group": "Troubleshooting", "group": "Troubleshooting",
"pages": ["troubleshooting/faq"] "pages": [
"troubleshooting/faq"
]
}, },
{ {
"group": "Legal", "group": "Legal",
"pages": ["legal/fulfillment-policy"] "pages": [
"legal/fulfillment-policy"
]
} }
], ],
"feedback": { "feedback": {

@ -0,0 +1,16 @@
---
title: "Light Server"
description: "Run your 01"
---
<Info> Make sure that you have navigated to the `software` directory. </Info>
The Light server streams bytes of audio to an ESP32 and the Light Python client.
It is very lightweight.
To run the Light server:
```bash
poetry run 01 --server light
```

@ -0,0 +1,23 @@
---
title: "Livekit Server"
description: "Run your 01"
---
<Info> Make sure that you have navigated to the `software` directory. </Info>
This server leverages the Livekit SDK and is used for the mobile apps.
It uses WebRTC for real-time communication and is very robust.
To run the Livekit server:
```bash
poetry run 01 --server livekit
```
<Note>
Speech to Text and Text to Speech are handled by Livekit plugins which
requires a Deepgram or ElevenLabs API key.
</Note>
Set env var API keys.

@ -1,18 +0,0 @@
---
title: "Run"
description: "Run your 01"
---
<Info> Make sure that you have navigated to the `software` directory. </Info>
To run the server and the client:
```bash
poetry run 01
```
To run the 01 server:
```bash
poetry run 01 --server
```
Loading…
Cancel
Save