From 89b91d2365d4f53d0182c689be8e2a6857432eb5 Mon Sep 17 00:00:00 2001 From: Mike Bird Date: Tue, 9 Jul 2024 15:53:51 -0400 Subject: [PATCH] improve software doc structure --- docs/mint.json | 7 ++++++- docs/software/{setup.mdx => configure.mdx} | 12 ++---------- docs/software/flags.mdx | 2 +- docs/software/installation.mdx | 12 +----------- docs/software/run.mdx | 18 ++++++++++++++++++ 5 files changed, 28 insertions(+), 23 deletions(-) rename docs/software/{setup.mdx => configure.mdx} (89%) create mode 100644 docs/software/run.mdx diff --git a/docs/mint.json b/docs/mint.json index d2d6edc..c28f93c 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -41,7 +41,12 @@ }, { "group": "Software Setup", - "pages": ["software/installation", "software/setup", "software/flags"] + "pages": [ + "software/installation", + "software/run", + "software/configure", + "software/flags" + ] }, { "group": "Hardware Setup", diff --git a/docs/software/setup.mdx b/docs/software/configure.mdx similarity index 89% rename from docs/software/setup.mdx rename to docs/software/configure.mdx index 31f7665..a1f81dc 100644 --- a/docs/software/setup.mdx +++ b/docs/software/configure.mdx @@ -1,16 +1,8 @@ --- -title: "Setup" -description: "Get your 01 server up and running" +title: "Configure" +description: "Configure your 01 instance" --- -## Run Server - -```bash -poetry run 01 --server -``` - -## Configure - A core part of the 01 server is the interpreter which is an instance of Open Interpreter. Open Interpreter is highly configurable and only requires updating a single file. diff --git a/docs/software/flags.mdx b/docs/software/flags.mdx index acfd369..2400252 100644 --- a/docs/software/flags.mdx +++ b/docs/software/flags.mdx @@ -1,6 +1,6 @@ --- title: "Flags" -description: "Customize the behaviour of your 01" +description: "Customize the behaviour of your 01 from the CLI" --- ## CLI Flags diff --git a/docs/software/installation.mdx b/docs/software/installation.mdx index 1d54c78..9cbbc93 100644 --- a/docs/software/installation.mdx +++ b/docs/software/installation.mdx @@ -28,14 +28,4 @@ Install your project along with its dependencies in a virtual environment manage poetry install ``` -Run your local version of 01 with: - -```bash -poetry run 01 -``` - -Use 01 with your 01 Light - -```bash -poetry run 01 --server -``` +Now you should be ready to [run your 01](/software/run) diff --git a/docs/software/run.mdx b/docs/software/run.mdx new file mode 100644 index 0000000..92d34ad --- /dev/null +++ b/docs/software/run.mdx @@ -0,0 +1,18 @@ +--- +title: "Run" +description: "Run your 01" +--- + + Make sure that you have navigated to the `software` directory. + +To run 01 with your computer's microphone and speaker, run: + +```bash +poetry run 01 +``` + +To use 01 with your 01 Light, run the server: + +```bash +poetry run 01 --server +```