reorder

adamcohenhillel · Feb 13, 2024 · 0db7e92 · 0db7e92
1 parent f3589ba
commit 0db7e92
Show file tree

Hide file tree

Showing 8 changed files with 44 additions and 51 deletions.
diff --git a/docs/archive/archive.md b/docs/archive/archive.md
@@ -1,8 +1,10 @@
 ---
 layout: default
-title: __archive
+title: _archive
 nav_order: 5
 has_children: true
 ---
 
+# Archive
+
 {: .no_toc }
diff --git a/docs/setup/setup_coralai.md → docs/archive/setup_coralai.md b/docs/setup/setup_coralai.md → docs/archive/setup_coralai.md
@@ -2,7 +2,7 @@
 title: Hardware - CoralAI hardware device
 description: add description
 layout: default
-parent: Setup
+parent: _archive
 ---
 
 Setting up hardware

diff --git a/docs/setup/setup_supabase.md → docs/getting_started.md b/docs/setup/setup_supabase.md → docs/getting_started.md
@@ -1,10 +1,13 @@
 ---
-title: Backend (Supabase)
-description: add description
 layout: default
-parent: Setup
+title: Getting Started (Set Up)
+nav_order: 2
 ---
 
+{: .no_toc }
+
+### 1. Backend (Supabase)
+
 Supabase is an open source Firebase alternative, a "backend-as-a-service" - which allows you to setup a Postgres database, Authentication, Edge Functions, Vector embeddings, and more - for free (at first) and at extreme ease!
 
 But more importantly - **it is open source, and you can choose to deploy and manage your own Supabase instance** - which is crucial for our mission: A truly open-source, personal AI.
@@ -51,3 +54,34 @@ How-to-Guide will be written here soon, but it should be fairly simple with [Oll
 ```
 brew install ngrok/ngrok/ngrok
 ```
+
+### 2. Web & Mobile App
+
+Now that you have a Supabase instance that is up and running, you can technically start chatting with your assistant, it just won't have any personal data it.
+
+To try it out, you can either use the deployed version of the web app here: [adeusai.com](https://adeusai.com) - which will ask you to connect to your own Supabase instance (it is only a frontend client).
+
+Or you can deploy the app yourself somewhere - the easiest is Vercel, or locally:
+
+from the root folder:
+
+```bash
+cd ./app
+```
+
+npm install and run:
+
+```bash
+npm i
+npm run dev
+```
+
+Once you have an app instance up and running, head to its address `your-app-address.com/`, and you should see the screen:
+
+<img src="../images/login_screenshot.png" width="150">
+
+Enter the four required details, which you should've obtained in the Supabase setup: `Supabase URL`, `Supabase Anon API Key`, `email` and `password`.
+
+And you should be able to start chatting!
+
+Now - let's configure our hardware device, so we could start provide crucial context to our personal AI!
diff --git a/docs/guides/guides.md b/docs/guides/guides.md
@@ -1,6 +1,6 @@
 ---
 layout: default
-title: How To
+title: How to Guides
 nav_order: 3
 has_children: true
 ---

diff --git a/docs/setup/setup_raspberry_pi_zero.md → docs/guides/setup_raspberry_pi_zero.md b/docs/setup/setup_raspberry_pi_zero.md → docs/guides/setup_raspberry_pi_zero.md
@@ -2,7 +2,7 @@
 title: Raspberry Pi Zero W Setup Guide
 description: add description
 layout: default
-parent: Setup
+parent: How to Guides
 ---
 
 This guide provides step-by-step instructions for setting up a Raspberry Pi Zero W with the necessary software and configurations for development purposes.

diff --git a/docs/guides/use_python_recorder.md b/docs/guides/use_python_recorder.md
@@ -2,7 +2,7 @@
 title: Develop without hardware device using a python script
 description: add description
 layout: default
-parent: How To
+parent: How to Guides
 ---
 
 ## Develop without the hardware device: Sound Recording With a Python Script

diff --git a/docs/setup/setup.md b/docs/setup/setup.md
diff --git a/docs/setup/setup_app.md b/docs/setup/setup_app.md