From e162dd88fa84478072d2c8f5a6fb10f8a0556ec9 Mon Sep 17 00:00:00 2001 From: Mike Bird Date: Mon, 29 Jul 2024 18:53:42 -0400 Subject: [PATCH] Added detailed component explanations, usage instructions, and contribution guidelines to `introduction.mdx` documentation. --- docs/software/configure.mdx | 2 +- docs/software/introduction.mdx | 49 +++++++++++++++++++++++++++++++--- 2 files changed, 46 insertions(+), 5 deletions(-) diff --git a/docs/software/configure.mdx b/docs/software/configure.mdx index ec2f310..fdf5245 100644 --- a/docs/software/configure.mdx +++ b/docs/software/configure.mdx @@ -14,7 +14,7 @@ To open the directory of all profiles, run: poetry run 01 --profiles ``` -To apply a profile to your 01 instance, use the `--profile` flag followed by the name of the profile +To apply a profile to your 01 instance, use the `--profile` flag followed by the name of the profile: ```bash # Use profile diff --git a/docs/software/introduction.mdx b/docs/software/introduction.mdx index d419aaa..13c056d 100644 --- a/docs/software/introduction.mdx +++ b/docs/software/introduction.mdx @@ -3,10 +3,51 @@ title: "Software" description: "The software that powers 01" --- -## What is the server? +## Overview -Runs on your computer +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. -## What is the client? +Our goal is to become the "Linux" of this new space—open, modular, and free for personal or commercial use. -Captures audio for controlling computers running the 01 server. +The current version of 01OS is a developer preview. + +## Components + +The 01 software consists of two main components: + +### Server + +The server runs on your computer and acts as the brain of the 01 system. It: + +- Passes input to the interpreter +- Executes commands on your computer +- Returns responses + +### Client + +The client is responsible for capturing audio for controlling computers running the 01 server. It: + +- Transmits audio to the server +- Plays back responses + +## Customization + +One of the key features of the 01 ecosystem is its modularity. You can: + +- Use different language models +- Customize the system's behavior through profiles +- Create and integrate custom hardware + +## Getting Started + +To begin using 01: + +1. [Install](/software/installation) the software +2. [Connect](/software/connect) your 01 device +3. [Run](/software/run) the server and client + +For more advanced usage, check out our guides on [configuration](/software/configure). + +## Contributing + +As an open-source project, we welcome contributions from the community. Whether you're interested in improving the core software, developing new features, or creating custom hardware integrations, there are many ways to get involved.