Skip to content

Commit

Permalink
Merge pull request #75 from OpenInterpreter/docs
Browse files Browse the repository at this point in the history
new docs structure
  • Loading branch information
KillianLucas authored Mar 13, 2024
2 parents ee289db + e755143 commit edeb372
Show file tree
Hide file tree
Showing 19 changed files with 109 additions and 337 deletions.
37 changes: 0 additions & 37 deletions docs/01os/01os-settings.mdx

This file was deleted.

105 changes: 0 additions & 105 deletions docs/01os/environment-variables.mdx

This file was deleted.

6 changes: 6 additions & 0 deletions docs/bodies/01-heavy.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "01 Heavy"
description: "Build your 01 Heavy"
---

runs fully locally + coming soon
6 changes: 6 additions & 0 deletions docs/bodies/01-light.mdx
Original file line number Diff line number Diff line change
@@ -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^)
9 changes: 9 additions & 0 deletions docs/client/setup.mdx
Original file line number Diff line number Diff line change
@@ -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")
30 changes: 30 additions & 0 deletions docs/getting-started/introduction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Introduction
description: "The open-source language model computer."
---

<img
src="https://openinterpreter.com/assets/banner.jpg"
alt="thumbnail"
style={{ transform: "translateY(-1.25rem)" }}
/>

The 01 project is an open-source ecosystem for artificially intelligent devices.

By combining code-interpreting language models ("interpreters") with speech recognition and voice synthesis, the 01’s flagship operating system ("01OS") can power conversational, computer-operating AI devices similar to the Rabbit R1 or the Humane Pin.

We intend to become the “Linux” of this new space— open, modular, and free for personal or commercial use.

## Quick Start

```bash
# Clone the repo, cd into the 01OS directory
git clone https://github.com/OpenInterpreter/01.git
cd 01OS

# Install dependencies and run start.py
poetry install
poetry run 01
```

_Disclaimer:_ The current version of 01OS is a developer preview.
6 changes: 6 additions & 0 deletions docs/getting-started/setup.mdx
Original file line number Diff line number Diff line change
@@ -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)
16 changes: 0 additions & 16 deletions docs/guides/hardware.mdx

This file was deleted.

55 changes: 0 additions & 55 deletions docs/guides/software.mdx

This file was deleted.

24 changes: 0 additions & 24 deletions docs/guides/teach.mdx

This file was deleted.

25 changes: 0 additions & 25 deletions docs/introduction.mdx

This file was deleted.

27 changes: 16 additions & 11 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"topbarLinks": [
{
"name": "GitHub",
"url": "https://github.com/KillianLucas/01"
"url": "https://github.com/OpenInterpreter/01"
}
],
"topbarCtaButton": {
Expand All @@ -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": {
Expand Down
11 changes: 11 additions & 0 deletions docs/server/setup.mdx
Original file line number Diff line number Diff line change
@@ -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)
9 changes: 9 additions & 0 deletions docs/services/language-model.mdx
Original file line number Diff line number Diff line change
@@ -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)
Loading

0 comments on commit edeb372

Please sign in to comment.