From 0b0334ad0d6a1a0eac81d6d93ea39125cb16a383 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 14:07:01 -0500 Subject: [PATCH 01/41] theme --- .gitignore | 16 +++++++ docs/Gemfile | 7 +++ docs/Gemfile.lock | 85 +++++++++++++++++++++++++++++++++++ docs/_config.yml | 8 ++++ docs/archive/launch_readme.md | 8 ++-- 5 files changed, 120 insertions(+), 4 deletions(-) create mode 100644 docs/Gemfile create mode 100644 docs/Gemfile.lock create mode 100644 docs/_config.yml diff --git a/.gitignore b/.gitignore index 4a148a9..84166e6 100644 --- a/.gitignore +++ b/.gitignore @@ -51,3 +51,19 @@ ios/App/fastlane/Appfile # pycache: __pycache__/ + +# Not sure what a .gitignore is? +# See: https://git-scm.com/docs/gitignore + +# These are directly copied from Jekyll's first-party docs on `.gitignore` files: +# https://jekyllrb.com/tutorials/using-jekyll-with-bundler/#commit-to-source-control + +# Ignore the default location of the built site, and caches and metadata generated by Jekyll +_site/ +.sass-cache/ +.jekyll-cache/ +.jekyll-metadata + +# Ignore folders generated by Bundler +.bundle/ +vendor/ \ No newline at end of file diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 0000000..d526ffb --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,7 @@ +source 'https://rubygems.org' + +gem "jekyll", "~> 4.3.3" # installed by `gem jekyll` +# gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2 + +gem "just-the-docs", "0.7.0" # pinned to the current release +# gem "just-the-docs" # always download the latest release \ No newline at end of file diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock new file mode 100644 index 0000000..ccbab01 --- /dev/null +++ b/docs/Gemfile.lock @@ -0,0 +1,85 @@ +GEM + remote: https://rubygems.org/ + specs: + addressable (2.8.6) + public_suffix (>= 2.0.2, < 6.0) + colorator (1.1.0) + concurrent-ruby (1.2.2) + em-websocket (0.5.3) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0) + eventmachine (1.2.7) + ffi (1.16.3) + forwardable-extended (2.6.0) + google-protobuf (3.25.1-arm64-darwin) + google-protobuf (3.25.1-x86_64-linux) + http_parser.rb (0.8.0) + i18n (1.14.1) + concurrent-ruby (~> 1.0) + jekyll (4.3.3) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 1.0) + jekyll-sass-converter (>= 2.0, < 4.0) + jekyll-watch (~> 2.0) + kramdown (~> 2.3, >= 2.3.1) + kramdown-parser-gfm (~> 1.0) + liquid (~> 4.0) + mercenary (>= 0.3.6, < 0.5) + pathutil (~> 0.9) + rouge (>= 3.0, < 5.0) + safe_yaml (~> 1.0) + terminal-table (>= 1.8, < 4.0) + webrick (~> 1.7) + jekyll-include-cache (0.2.1) + jekyll (>= 3.7, < 5.0) + jekyll-sass-converter (3.0.0) + sass-embedded (~> 1.54) + jekyll-seo-tag (2.8.0) + jekyll (>= 3.8, < 5.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + just-the-docs (0.7.0) + jekyll (>= 3.8.5) + jekyll-include-cache + jekyll-seo-tag (>= 2.0) + rake (>= 12.3.1) + kramdown (2.4.0) + rexml + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.4) + listen (3.8.0) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.4.0) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (5.0.4) + rake (13.0.6) + rb-fsevent (0.11.2) + rb-inotify (0.10.1) + ffi (~> 1.0) + rexml (3.2.6) + rouge (4.2.0) + safe_yaml (1.0.5) + sass-embedded (1.69.5-arm64-darwin) + google-protobuf (~> 3.23) + sass-embedded (1.69.5-x86_64-linux-gnu) + google-protobuf (~> 3.23) + terminal-table (3.0.2) + unicode-display_width (>= 1.1.1, < 3) + unicode-display_width (2.5.0) + webrick (1.8.1) + +PLATFORMS + arm64-darwin-23 + x86_64-linux + +DEPENDENCIES + jekyll (~> 4.3.3) + just-the-docs (= 0.7.0) + +BUNDLED WITH + 2.3.26 \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..ba68977 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,8 @@ +title: Adeus Documentation +description: Open Source AI Wearable device +theme: just-the-docs + +url: https://just-the-docs.github.io + +aux_links: + Template Repository: https://github.com/just-the-docs/just-the-docs-template diff --git a/docs/archive/launch_readme.md b/docs/archive/launch_readme.md index 56e3f0a..b190235 100644 --- a/docs/archive/launch_readme.md +++ b/docs/archive/launch_readme.md @@ -15,7 +15,7 @@ In the upcoming world of AI devices like [Tab](https://mytab.ai/), [Pin](https:/ - [Areas to Contribute](#areas-to-contribute) - [CTA for the Community](#cta-for-the-community) -![ADeus v0.1](docs/images/adeus_01.jpeg) +![ADeus v0.1](https://github.com/adamcohenhillel/ADeus/tree/main/docs/images/adeus_01.jpeg) > p.s. any contribution would be amazing, whether you know how to code, and want to jump straight in to the codebase, a hardware person who can help out, or just looking to support this project financially (can literally be $10) - please reach out to me on X/Twitter [@adamcohenhillel](https://twitter.com/adamcohenhillel) @@ -32,7 +32,7 @@ Adeus consists of 3 parts: - [!!] But more importantly - **it is open source, and you can choose to deploy and manage your own Supabase instance** - which us crucial for our mission: A truly open-source, personal AI. This will look something like: -![ADeus diagram](docs/images/adeus_diagram.png) +![ADeus diagram](https://github.com/adamcohenhillel/ADeus/tree/main/docs/images/adeus_diagram.png) ## Setup @@ -69,7 +69,7 @@ First, to learn more about the device, it is good to check out the [official doc Here is quick video showing how to "connect" the hardware pieces together, and install the software: -[![set up device video](docs/images/thumbnail_2.png)](https://youtu.be/_2KRSlpnXrA) +[![set up device video](https://github.com/adamcohenhillel/ADeus/tree/main/docs/images/thumbnail_2.png)](https://youtu.be/_2KRSlpnXrA) In the root folder of this repository, run the following commands, (which will download the Coral AI Micro Dev dependencies to your computer - note that it might take a few minutes): @@ -175,4 +175,4 @@ The pioneers of the personal computers, the internet, they all knew it - and tha Check out the Intro video: -[![set up device video](docs/images/thumbnail_1.png)](https://youtu.be/4CqEC2yLGQU) +[![set up device video](https://github.com/adamcohenhillel/ADeus/tree/main/docs/images/thumbnail_1.png)](https://youtu.be/4CqEC2yLGQU) From 5b182d641b5d8719feaeb7b84c3fcf3cfa34bd40 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 14:56:45 -0500 Subject: [PATCH 02/41] github actions --- .github/dependabot.yml | 8 +++++ .github/workflows/ci.yml | 22 ++++++++++++ .github/workflows/pages.yml | 68 +++++++++++++++++++++++++++++++++++++ docs/Gemfile | 2 +- docs/Gemfile.lock | 2 +- 5 files changed, 100 insertions(+), 2 deletions(-) create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/ci.yml create mode 100644 .github/workflows/pages.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..ff1a325 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,8 @@ +version: 2 +updates: + - package-ecosystem: bundler + directory: / + schedule: + interval: daily + allow: + - dependency-type: direct diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..a7b5e9b --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,22 @@ +name: CI + +on: + push: + branches: ["main"] + pull_request: + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Setup Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: '3.1' # Not needed with a .ruby-version file + bundler-cache: true # runs 'bundle install' and caches installed gems automatically + cache-version: 0 # Increment this number if you need to re-download cached gems + - name: Build with Jekyll + run: bundle exec jekyll build diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml new file mode 100644 index 0000000..e38dc14 --- /dev/null +++ b/.github/workflows/pages.yml @@ -0,0 +1,68 @@ +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +# Sample workflow for building and deploying a Jekyll site to GitHub Pages +name: Deploy Jekyll site to Pages + +on: + push: + branches: + - "work-on-the-docs" + paths: + - "docs/**" + + # Allows you to run this workflow manually from the Actions tab + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow one concurrent deployment +concurrency: + group: "pages" + cancel-in-progress: true + +jobs: + # Build job + build: + runs-on: ubuntu-latest + working-directory: docs + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Setup Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: "3.1" # Not needed with a .ruby-version file + bundler-cache: true # runs 'bundle install' and caches installed gems automatically + cache-version: 0 # Increment this number if you need to re-download cached gems + working-directory: "${{ github.workspace }}/docs" + - name: Setup Pages + id: pages + uses: actions/configure-pages@v3 + - name: Build with Jekyll + # Outputs to the './_site' directory by default + run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" + env: + JEKYLL_ENV: production + - name: Upload artifact + # Automatically uploads an artifact from the './_site' directory by default + uses: actions/upload-pages-artifact@v1 + with: + path: "docs/_site/" + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 diff --git a/docs/Gemfile b/docs/Gemfile index d526ffb..3aec09b 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -4,4 +4,4 @@ gem "jekyll", "~> 4.3.3" # installed by `gem jekyll` # gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2 gem "just-the-docs", "0.7.0" # pinned to the current release -# gem "just-the-docs" # always download the latest release \ No newline at end of file +# gem "just-the-docs" # always download the latest release diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index ccbab01..5912780 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -82,4 +82,4 @@ DEPENDENCIES just-the-docs (= 0.7.0) BUNDLED WITH - 2.3.26 \ No newline at end of file + 2.3.26 From c4cdb407f8931fac83dcc520bb4afd3c6f684cef Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 14:59:21 -0500 Subject: [PATCH 03/41] working-director docs --- .github/workflows/pages.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index e38dc14..1df5f1e 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -30,12 +30,12 @@ jobs: # Build job build: runs-on: ubuntu-latest - working-directory: docs steps: - name: Checkout uses: actions/checkout@v3 - name: Setup Ruby uses: ruby/setup-ruby@v1 + working-directory: docs with: ruby-version: "3.1" # Not needed with a .ruby-version file bundler-cache: true # runs 'bundle install' and caches installed gems automatically @@ -46,6 +46,7 @@ jobs: uses: actions/configure-pages@v3 - name: Build with Jekyll # Outputs to the './_site' directory by default + working-directory: docs run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" env: JEKYLL_ENV: production From 5dfa2de23dd0dbfe2887822700e763634527ea2d Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 15:07:57 -0500 Subject: [PATCH 04/41] try --- .github/dependabot.yml | 8 -------- .github/workflows/ci.yml | 22 ---------------------- .github/workflows/pages.yml | 7 ++++--- 3 files changed, 4 insertions(+), 33 deletions(-) delete mode 100644 .github/dependabot.yml delete mode 100644 .github/workflows/ci.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml deleted file mode 100644 index ff1a325..0000000 --- a/.github/dependabot.yml +++ /dev/null @@ -1,8 +0,0 @@ -version: 2 -updates: - - package-ecosystem: bundler - directory: / - schedule: - interval: daily - allow: - - dependency-type: direct diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml deleted file mode 100644 index a7b5e9b..0000000 --- a/.github/workflows/ci.yml +++ /dev/null @@ -1,22 +0,0 @@ -name: CI - -on: - push: - branches: ["main"] - pull_request: - -jobs: - # Build job - build: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v3 - - name: Setup Ruby - uses: ruby/setup-ruby@v1 - with: - ruby-version: '3.1' # Not needed with a .ruby-version file - bundler-cache: true # runs 'bundle install' and caches installed gems automatically - cache-version: 0 # Increment this number if you need to re-download cached gems - - name: Build with Jekyll - run: bundle exec jekyll build diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 1df5f1e..52e9eb0 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -10,8 +10,8 @@ on: push: branches: - "work-on-the-docs" - paths: - - "docs/**" + # paths: + # - "docs/**" # Allows you to run this workflow manually from the Actions tab @@ -44,9 +44,10 @@ jobs: - name: Setup Pages id: pages uses: actions/configure-pages@v3 + working-directory: docs - name: Build with Jekyll # Outputs to the './_site' directory by default - working-directory: docs + working-directory: ./docs run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" env: JEKYLL_ENV: production From 2b78aff4e462251711adfbe224778cea0b840251 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 15:09:02 -0500 Subject: [PATCH 05/41] ffs --- .github/workflows/pages.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 52e9eb0..fa2505d 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -35,7 +35,6 @@ jobs: uses: actions/checkout@v3 - name: Setup Ruby uses: ruby/setup-ruby@v1 - working-directory: docs with: ruby-version: "3.1" # Not needed with a .ruby-version file bundler-cache: true # runs 'bundle install' and caches installed gems automatically From 051eb14995863f4c2e42b27318a022db318bac2a Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 15:10:19 -0500 Subject: [PATCH 06/41] ffs2 --- .github/workflows/pages.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index fa2505d..0505ffb 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -43,7 +43,6 @@ jobs: - name: Setup Pages id: pages uses: actions/configure-pages@v3 - working-directory: docs - name: Build with Jekyll # Outputs to the './_site' directory by default working-directory: ./docs From 09b25e75083130932750f6fe79e4cdad82088305 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 15:15:06 -0500 Subject: [PATCH 07/41] add layout --- docs/index.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/index.md b/docs/index.md index da8fbc0..fd4e33f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,8 @@ +--- +title: Home +layout: home +--- + ### Documentation Welcome, contributer! What you are doing here is truly amazing. Open source contributors are the unsung heroes of technology, the backbone of our modern, OPEN, world. so thank you for being here. From d693e199014b40bd7ae88419374e10e4490988a9 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 16:28:43 -0500 Subject: [PATCH 08/41] clean --- docs/_config.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index ba68977..979402c 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -2,7 +2,7 @@ title: Adeus Documentation description: Open Source AI Wearable device theme: just-the-docs -url: https://just-the-docs.github.io +url: https://docs.adeus.ai aux_links: - Template Repository: https://github.com/just-the-docs/just-the-docs-template + Github: https://github.com/adamcohenhillel/ADeus From 935883892440c4b4dc8a2ab0036631f879bd7c66 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 16:33:50 -0500 Subject: [PATCH 09/41] theme --- docs/how-to/setup_app.md | 1 + docs/how-to/setup_coralai.md | 1 + docs/how-to/setup_raspberry_pi_zero.md | 6 ++++++ docs/how-to/setup_supabase.md | 1 + docs/how-to/use_python_recorder.md | 1 + 5 files changed, 10 insertions(+) diff --git a/docs/how-to/setup_app.md b/docs/how-to/setup_app.md index 709873b..dfc78e5 100644 --- a/docs/how-to/setup_app.md +++ b/docs/how-to/setup_app.md @@ -1,6 +1,7 @@ --- title: Setting up the mobile / web app description: add description +layout: home --- 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. diff --git a/docs/how-to/setup_coralai.md b/docs/how-to/setup_coralai.md index 7f846eb..91381e5 100644 --- a/docs/how-to/setup_coralai.md +++ b/docs/how-to/setup_coralai.md @@ -1,6 +1,7 @@ --- title: Setting up the CoralAI hardware device description: add description +layout: home --- #### Prerequisite: ($110) diff --git a/docs/how-to/setup_raspberry_pi_zero.md b/docs/how-to/setup_raspberry_pi_zero.md index 4de909b..2b716e5 100644 --- a/docs/how-to/setup_raspberry_pi_zero.md +++ b/docs/how-to/setup_raspberry_pi_zero.md @@ -1,3 +1,9 @@ +--- +title: Raspberry Pi Zero W Setup Guide +description: add description +layout: home +--- + # Raspberry Pi Zero W Setup Guide 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/how-to/setup_supabase.md b/docs/how-to/setup_supabase.md index b186c36..24cbcb2 100644 --- a/docs/how-to/setup_supabase.md +++ b/docs/how-to/setup_supabase.md @@ -1,6 +1,7 @@ --- title: Setting up the backend (Supabase) description: add description +layout: home --- 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! diff --git a/docs/how-to/use_python_recorder.md b/docs/how-to/use_python_recorder.md index b398c9d..5749123 100644 --- a/docs/how-to/use_python_recorder.md +++ b/docs/how-to/use_python_recorder.md @@ -1,6 +1,7 @@ --- title: How to start Contributing description: add description +layout: home2 --- ## Develop without the hardware device: Sound Recording With a Python Script From 9e2ace60fc5640f0798795d104845547b4fd5558 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 16:42:42 -0500 Subject: [PATCH 10/41] changes --- docs/index.md | 2 +- docs/setup/index.md | 6 ++++++ docs/{how-to => setup}/setup_app.md | 3 ++- docs/{how-to => setup}/setup_coralai.md | 3 ++- docs/{how-to => setup}/setup_raspberry_pi_zero.md | 3 ++- docs/{how-to => setup}/setup_supabase.md | 3 ++- docs/{how-to => setup}/use_python_recorder.md | 3 ++- 7 files changed, 17 insertions(+), 6 deletions(-) create mode 100644 docs/setup/index.md rename docs/{how-to => setup}/setup_app.md (97%) rename docs/{how-to => setup}/setup_coralai.md (99%) rename docs/{how-to => setup}/setup_raspberry_pi_zero.md (99%) rename docs/{how-to => setup}/setup_supabase.md (99%) rename docs/{how-to => setup}/use_python_recorder.md (98%) diff --git a/docs/index.md b/docs/index.md index fd4e33f..6f8e4f5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ --- title: Home -layout: home +layout: default --- ### Documentation diff --git a/docs/setup/index.md b/docs/setup/index.md new file mode 100644 index 0000000..2a213c2 --- /dev/null +++ b/docs/setup/index.md @@ -0,0 +1,6 @@ +--- +title: UI Components +layout: default +nav_order: 3 +has_children: true +--- diff --git a/docs/how-to/setup_app.md b/docs/setup/setup_app.md similarity index 97% rename from docs/how-to/setup_app.md rename to docs/setup/setup_app.md index dfc78e5..9ab7f59 100644 --- a/docs/how-to/setup_app.md +++ b/docs/setup/setup_app.md @@ -1,7 +1,8 @@ --- title: Setting up the mobile / web app description: add description -layout: home +layout: default +nav_order: 2 --- 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. diff --git a/docs/how-to/setup_coralai.md b/docs/setup/setup_coralai.md similarity index 99% rename from docs/how-to/setup_coralai.md rename to docs/setup/setup_coralai.md index 91381e5..ff4955b 100644 --- a/docs/how-to/setup_coralai.md +++ b/docs/setup/setup_coralai.md @@ -1,7 +1,8 @@ --- title: Setting up the CoralAI hardware device description: add description -layout: home +layout: default +nav_order: 3 --- #### Prerequisite: ($110) diff --git a/docs/how-to/setup_raspberry_pi_zero.md b/docs/setup/setup_raspberry_pi_zero.md similarity index 99% rename from docs/how-to/setup_raspberry_pi_zero.md rename to docs/setup/setup_raspberry_pi_zero.md index 2b716e5..da343e8 100644 --- a/docs/how-to/setup_raspberry_pi_zero.md +++ b/docs/setup/setup_raspberry_pi_zero.md @@ -1,7 +1,8 @@ --- title: Raspberry Pi Zero W Setup Guide description: add description -layout: home +layout: default +nav_order: 4 --- # Raspberry Pi Zero W Setup Guide diff --git a/docs/how-to/setup_supabase.md b/docs/setup/setup_supabase.md similarity index 99% rename from docs/how-to/setup_supabase.md rename to docs/setup/setup_supabase.md index 24cbcb2..9327c58 100644 --- a/docs/how-to/setup_supabase.md +++ b/docs/setup/setup_supabase.md @@ -1,7 +1,8 @@ --- title: Setting up the backend (Supabase) description: add description -layout: home +layout: default +nav_order: 1 --- 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! diff --git a/docs/how-to/use_python_recorder.md b/docs/setup/use_python_recorder.md similarity index 98% rename from docs/how-to/use_python_recorder.md rename to docs/setup/use_python_recorder.md index 5749123..98d11ce 100644 --- a/docs/how-to/use_python_recorder.md +++ b/docs/setup/use_python_recorder.md @@ -1,7 +1,8 @@ --- title: How to start Contributing description: add description -layout: home2 +layout: default +nav_order: 5 --- ## Develop without the hardware device: Sound Recording With a Python Script From 4faa4e0bbc9572664272c9f0dbc56b984cbe6983 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 16:47:18 -0500 Subject: [PATCH 11/41] small changes --- docs/index.md | 5 +++-- docs/setup/index.md | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index 6f8e4f5..2cef7a4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,7 @@ --- title: Home layout: default +nav_order: 1 --- ### Documentation @@ -13,8 +14,8 @@ Welcome, contributer! What you are doing here is truly amazing. Open source cont - [Introduction](#introduction) - [Getting Started](#getting-started) - - [Set up Supabase](./how-to/setup_supabase.md) - - [Set up Web / Mobile App](./how-to/setup_app.md) + - [Set up Supabase](./setup/setup_supabase.md) + - [Set up Web / Mobile App](./setup/setup_app.md) - [Hardware (Coral AI)](#setup-hardware-coral-ai-device-↗) - [Resources](#resoucres) - [How to Contribute](#how-to-contribute) diff --git a/docs/setup/index.md b/docs/setup/index.md index 2a213c2..e31f024 100644 --- a/docs/setup/index.md +++ b/docs/setup/index.md @@ -1,6 +1,6 @@ --- -title: UI Components +title: Setup layout: default -nav_order: 3 has_children: true +nav_order: 2 --- From 76d80a402e73c837058aed45f3fe3f3003310fad Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 16:52:26 -0500 Subject: [PATCH 12/41] changes --- docs/setup/{index.md => setup.md} | 9 +++++++-- docs/setup/setup_supabase.md | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-) rename docs/setup/{index.md => setup.md} (58%) diff --git a/docs/setup/index.md b/docs/setup/setup.md similarity index 58% rename from docs/setup/index.md rename to docs/setup/setup.md index e31f024..72dd3d0 100644 --- a/docs/setup/index.md +++ b/docs/setup/setup.md @@ -1,6 +1,11 @@ --- -title: Setup layout: default -has_children: true +title: Setup nav_order: 2 +has_children: true +permalink: docs/setup --- + +# Utilities + +{: .no_toc } diff --git a/docs/setup/setup_supabase.md b/docs/setup/setup_supabase.md index 9327c58..544cdfa 100644 --- a/docs/setup/setup_supabase.md +++ b/docs/setup/setup_supabase.md @@ -1,5 +1,5 @@ --- -title: Setting up the backend (Supabase) +title: Backend (Supabase) description: add description layout: default nav_order: 1 From 16a05999fe3f762fddd203b9d8414b09744d26bf Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 16:53:45 -0500 Subject: [PATCH 13/41] abc --- docs/index.md | 2 -- docs/setup/setup_app.md | 1 - docs/setup/setup_coralai.md | 1 - docs/setup/setup_raspberry_pi_zero.md | 1 - docs/setup/setup_supabase.md | 1 - 5 files changed, 6 deletions(-) diff --git a/docs/index.md b/docs/index.md index 2cef7a4..68ee66e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,8 +4,6 @@ layout: default nav_order: 1 --- -### Documentation - Welcome, contributer! What you are doing here is truly amazing. Open source contributors are the unsung heroes of technology, the backbone of our modern, OPEN, world. so thank you for being here. **Now, let's get started!** diff --git a/docs/setup/setup_app.md b/docs/setup/setup_app.md index 9ab7f59..c5c1cc2 100644 --- a/docs/setup/setup_app.md +++ b/docs/setup/setup_app.md @@ -2,7 +2,6 @@ title: Setting up the mobile / web app description: add description layout: default -nav_order: 2 --- 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. diff --git a/docs/setup/setup_coralai.md b/docs/setup/setup_coralai.md index ff4955b..1635219 100644 --- a/docs/setup/setup_coralai.md +++ b/docs/setup/setup_coralai.md @@ -2,7 +2,6 @@ title: Setting up the CoralAI hardware device description: add description layout: default -nav_order: 3 --- #### Prerequisite: ($110) diff --git a/docs/setup/setup_raspberry_pi_zero.md b/docs/setup/setup_raspberry_pi_zero.md index da343e8..43bdc58 100644 --- a/docs/setup/setup_raspberry_pi_zero.md +++ b/docs/setup/setup_raspberry_pi_zero.md @@ -2,7 +2,6 @@ title: Raspberry Pi Zero W Setup Guide description: add description layout: default -nav_order: 4 --- # Raspberry Pi Zero W Setup Guide diff --git a/docs/setup/setup_supabase.md b/docs/setup/setup_supabase.md index 544cdfa..dfa90f0 100644 --- a/docs/setup/setup_supabase.md +++ b/docs/setup/setup_supabase.md @@ -2,7 +2,6 @@ title: Backend (Supabase) description: add description layout: default -nav_order: 1 --- 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! From 8c0365db2555baa5e8df48d96cc1d070a17d95d0 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 16:57:08 -0500 Subject: [PATCH 14/41] parent --- docs/archive/archive.md | 9 +++++++++ docs/archive/launch_readme.md | 6 ++++++ docs/setup/setup.md | 2 -- docs/setup/setup_supabase.md | 1 + docs/setup/use_python_recorder.md | 1 - 5 files changed, 16 insertions(+), 3 deletions(-) create mode 100644 docs/archive/archive.md diff --git a/docs/archive/archive.md b/docs/archive/archive.md new file mode 100644 index 0000000..cd21c35 --- /dev/null +++ b/docs/archive/archive.md @@ -0,0 +1,9 @@ +--- +layout: default +title: Archive +nav_order: 6 +has_children: true +permalink: docs/setup +--- + +{: .no_toc } diff --git a/docs/archive/launch_readme.md b/docs/archive/launch_readme.md index b190235..725c163 100644 --- a/docs/archive/launch_readme.md +++ b/docs/archive/launch_readme.md @@ -1,3 +1,9 @@ +--- +title: Launch Readme Version +description: add description +layout: default +--- + # ADeus: Open-Source AI Wearable Device In the upcoming world of AI devices like [Tab](https://mytab.ai/), [Pin](https://hu.ma.ne/aipin), [Rewind](https://www.rewind.ai/pendant), that are with us all the time, **literally** listening to everything we say, and know much about us as our closest friends - it is crucial to be able to own this setup, to own our data, to have this completely open source, managed by the user itself. diff --git a/docs/setup/setup.md b/docs/setup/setup.md index 72dd3d0..bb8169f 100644 --- a/docs/setup/setup.md +++ b/docs/setup/setup.md @@ -6,6 +6,4 @@ has_children: true permalink: docs/setup --- -# Utilities - {: .no_toc } diff --git a/docs/setup/setup_supabase.md b/docs/setup/setup_supabase.md index dfa90f0..ee91be1 100644 --- a/docs/setup/setup_supabase.md +++ b/docs/setup/setup_supabase.md @@ -2,6 +2,7 @@ title: Backend (Supabase) description: add description layout: default +parent: Setup --- 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! diff --git a/docs/setup/use_python_recorder.md b/docs/setup/use_python_recorder.md index 98d11ce..9ff77de 100644 --- a/docs/setup/use_python_recorder.md +++ b/docs/setup/use_python_recorder.md @@ -2,7 +2,6 @@ title: How to start Contributing description: add description layout: default -nav_order: 5 --- ## Develop without the hardware device: Sound Recording With a Python Script From 71cbad29f912f42aff5cfae1ace7dee5e5e10afb Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 17:00:30 -0500 Subject: [PATCH 15/41] remove title --- docs/archive/archive.md | 2 +- docs/archive/launch_readme.md | 1 + docs/setup/setup_raspberry_pi_zero.md | 3 +-- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/archive/archive.md b/docs/archive/archive.md index cd21c35..812806a 100644 --- a/docs/archive/archive.md +++ b/docs/archive/archive.md @@ -3,7 +3,7 @@ layout: default title: Archive nav_order: 6 has_children: true -permalink: docs/setup +permalink: docs/archive --- {: .no_toc } diff --git a/docs/archive/launch_readme.md b/docs/archive/launch_readme.md index 725c163..d807475 100644 --- a/docs/archive/launch_readme.md +++ b/docs/archive/launch_readme.md @@ -2,6 +2,7 @@ title: Launch Readme Version description: add description layout: default +parent: Archive --- # ADeus: Open-Source AI Wearable Device diff --git a/docs/setup/setup_raspberry_pi_zero.md b/docs/setup/setup_raspberry_pi_zero.md index 43bdc58..748d74d 100644 --- a/docs/setup/setup_raspberry_pi_zero.md +++ b/docs/setup/setup_raspberry_pi_zero.md @@ -2,10 +2,9 @@ title: Raspberry Pi Zero W Setup Guide description: add description layout: default +parent: Setup --- -# Raspberry Pi Zero W Setup Guide - This guide provides step-by-step instructions for setting up a Raspberry Pi Zero W with the necessary software and configurations for development purposes. ## Prerequisites From 2cbf8074fd7dd2927eba6f18a5cd5d6ca01b4945 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 17:05:33 -0500 Subject: [PATCH 16/41] docs --- docs/archive/archive.md | 1 - docs/setup/setup.md | 1 - docs/setup/setup_app.md | 5 +++-- docs/setup/setup_coralai.md | 7 +++++-- 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/archive/archive.md b/docs/archive/archive.md index 812806a..a055244 100644 --- a/docs/archive/archive.md +++ b/docs/archive/archive.md @@ -3,7 +3,6 @@ layout: default title: Archive nav_order: 6 has_children: true -permalink: docs/archive --- {: .no_toc } diff --git a/docs/setup/setup.md b/docs/setup/setup.md index bb8169f..fb8e6cb 100644 --- a/docs/setup/setup.md +++ b/docs/setup/setup.md @@ -3,7 +3,6 @@ layout: default title: Setup nav_order: 2 has_children: true -permalink: docs/setup --- {: .no_toc } diff --git a/docs/setup/setup_app.md b/docs/setup/setup_app.md index c5c1cc2..5b66007 100644 --- a/docs/setup/setup_app.md +++ b/docs/setup/setup_app.md @@ -1,7 +1,8 @@ --- -title: Setting up the mobile / web app +title: Web / Mobile app description: add description layout: default +parent: Setup --- 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. @@ -25,7 +26,7 @@ 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: - + Enter the four required details, which you should've obtained in the Supabase setup: `Supabase URL`, `Supabase Anon API Key`, `email` and `password`. diff --git a/docs/setup/setup_coralai.md b/docs/setup/setup_coralai.md index 1635219..ba2e6cb 100644 --- a/docs/setup/setup_coralai.md +++ b/docs/setup/setup_coralai.md @@ -1,9 +1,12 @@ --- -title: Setting up the CoralAI hardware device +title: Hardware - CoralAI hardware device description: add description layout: default +parent: Setup --- +Setting up hardware + #### Prerequisite: ($110) 1. [Dev Board Micro](https://coral.ai/products/dev-board-micro/) ($80) @@ -19,7 +22,7 @@ First, to learn more about the device, it is good to check out the [official doc Here is quick video showing how to "connect" the hardware pieces together, and install the software: -[![set up device video](docs/images/thumbnail_2.png)](https://youtu.be/_2KRSlpnXrA) +[![set up device video](../images/thumbnail_2.png)](https://youtu.be/_2KRSlpnXrA) In the root folder of this repository, run the following commands, (which will download the Coral AI Micro Dev dependencies to your computer - note that it might take a few minutes): From c5bb388be8aa0149b38a7444af5031929376f724 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 17:15:01 -0500 Subject: [PATCH 17/41] some changes --- docs/_config.yml | 7 +++++++ docs/guides/guides.md | 8 ++++++++ docs/{setup => guides}/use_python_recorder.md | 1 + docs/index.md | 4 +++- docs/setup/setup_app.md | 2 +- 5 files changed, 20 insertions(+), 2 deletions(-) create mode 100644 docs/guides/guides.md rename docs/{setup => guides}/use_python_recorder.md (99%) diff --git a/docs/_config.yml b/docs/_config.yml index 979402c..77e57d7 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -6,3 +6,10 @@ url: https://docs.adeus.ai aux_links: Github: https://github.com/adamcohenhillel/ADeus + +aux_links_new_tab: true + +nav_external_links: + - title: Adeus on GitHub + url: https://github.com/adamcohenhillel/ADeus + opens_in_new_tab: true diff --git a/docs/guides/guides.md b/docs/guides/guides.md new file mode 100644 index 0000000..74ff246 --- /dev/null +++ b/docs/guides/guides.md @@ -0,0 +1,8 @@ +--- +layout: default +title: How To +nav_order: 3 +has_children: true +--- + +{: .no_toc } diff --git a/docs/setup/use_python_recorder.md b/docs/guides/use_python_recorder.md similarity index 99% rename from docs/setup/use_python_recorder.md rename to docs/guides/use_python_recorder.md index 9ff77de..8010c89 100644 --- a/docs/setup/use_python_recorder.md +++ b/docs/guides/use_python_recorder.md @@ -2,6 +2,7 @@ title: How to start Contributing description: add description layout: default +parent: How To --- ## Develop without the hardware device: Sound Recording With a Python Script diff --git a/docs/index.md b/docs/index.md index 68ee66e..13acc47 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,9 @@ layout: default nav_order: 1 --- -Welcome, contributer! What you are doing here is truly amazing. Open source contributors are the unsung heroes of technology, the backbone of our modern, OPEN, world. so thank you for being here. +Welcome contributer, + +What you are doing here is truly amazing. Open-source contributors are the unsung heroes of technology, the backbone of our modern, OPEN, world. so thank you for being here. **Now, let's get started!** diff --git a/docs/setup/setup_app.md b/docs/setup/setup_app.md index 5b66007..68f39ac 100644 --- a/docs/setup/setup_app.md +++ b/docs/setup/setup_app.md @@ -1,5 +1,5 @@ --- -title: Web / Mobile app +title: Web & Mobile App description: add description layout: default parent: Setup From 6ace53bc1f0c613334dc1dc1f948eab6ab8d3d6c Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 17:19:11 -0500 Subject: [PATCH 18/41] docsg --- docs/guides/use_python_recorder.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/use_python_recorder.md b/docs/guides/use_python_recorder.md index 8010c89..142b1be 100644 --- a/docs/guides/use_python_recorder.md +++ b/docs/guides/use_python_recorder.md @@ -1,5 +1,5 @@ --- -title: How to start Contributing +title: Develop without hardware device using a python script description: add description layout: default parent: How To From d0a5d5781968f9817ae9b3f12f28662c145c7d13 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 17:36:15 -0500 Subject: [PATCH 19/41] discord stuff --- docs/_config.yml | 4 ++++ docs/archive/archive.md | 4 ++-- docs/archive/launch_readme.md | 2 +- docs/troubleshoot.md | 41 +++++++++++++++++++++++++++++++++++ 4 files changed, 48 insertions(+), 3 deletions(-) create mode 100644 docs/troubleshoot.md diff --git a/docs/_config.yml b/docs/_config.yml index 77e57d7..a64aa4b 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -10,6 +10,10 @@ aux_links: aux_links_new_tab: true nav_external_links: + - title: Join Us on Discord + url: https://discord.gg/N5c6KXBgWW + opens_in_new_tab: true + - title: Adeus on GitHub url: https://github.com/adamcohenhillel/ADeus opens_in_new_tab: true diff --git a/docs/archive/archive.md b/docs/archive/archive.md index a055244..43607e7 100644 --- a/docs/archive/archive.md +++ b/docs/archive/archive.md @@ -1,7 +1,7 @@ --- layout: default -title: Archive -nav_order: 6 +title: __archive +nav_order: 5 has_children: true --- diff --git a/docs/archive/launch_readme.md b/docs/archive/launch_readme.md index d807475..235c42d 100644 --- a/docs/archive/launch_readme.md +++ b/docs/archive/launch_readme.md @@ -2,7 +2,7 @@ title: Launch Readme Version description: add description layout: default -parent: Archive +parent: __archive --- # ADeus: Open-Source AI Wearable Device diff --git a/docs/troubleshoot.md b/docs/troubleshoot.md new file mode 100644 index 0000000..66dc19f --- /dev/null +++ b/docs/troubleshoot.md @@ -0,0 +1,41 @@ +--- +title: Troubleshoot +layout: default +nav_order: 6 +--- + +Welcome contributer, + +What you are doing here is truly amazing. Open-source contributors are the unsung heroes of technology, the backbone of our modern, OPEN, world. so thank you for being here. + +**Now, let's get started!** + +## Table of contents + +- [Introduction](#introduction) +- [Getting Started](#getting-started) + - [Set up Supabase](./setup/setup_supabase.md) + - [Set up Web / Mobile App](./setup/setup_app.md) + - [Hardware (Coral AI)](#setup-hardware-coral-ai-device-↗) +- [Resources](#resoucres) +- [How to Contribute](#how-to-contribute) + +First, let's understand how Adeus is built: + +Adeus consists of 3 parts: + +![ADeus diagram](./images/adeus_diagram.png) + +1. **A mobile / web app:** + an interface that lets the user to interact with their assistant and data via chat. + +2. **Hardware device (Currently Coral AI, but soon a Rasberry-Pi Zero W worth $15):** this will be the wearable that will record everything, and send it to the backend to be processed +3. **Supabase :** Our backend, and datavase, where we will process and store data, and interact with LLMs. + 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 us crucial for our mission: A truly open-source, personal AI. + +## Getting Started + +### Resources + +### How to Contribute From a2f2d2fcd1afa71585d82a3eae59ff2093018b66 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 17:40:27 -0500 Subject: [PATCH 20/41] some nice changes --- docs/_config.yml | 4 ++-- docs/archive/launch_readme.md | 2 +- docs/index.md | 4 ++-- docs/troubleshoot.md | 38 +---------------------------------- 4 files changed, 6 insertions(+), 42 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index a64aa4b..cf40080 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -10,10 +10,10 @@ aux_links: aux_links_new_tab: true nav_external_links: - - title: Join Us on Discord + - title: Discord url: https://discord.gg/N5c6KXBgWW opens_in_new_tab: true - - title: Adeus on GitHub + - title: GitHub url: https://github.com/adamcohenhillel/ADeus opens_in_new_tab: true diff --git a/docs/archive/launch_readme.md b/docs/archive/launch_readme.md index 235c42d..50cbbad 100644 --- a/docs/archive/launch_readme.md +++ b/docs/archive/launch_readme.md @@ -2,7 +2,7 @@ title: Launch Readme Version description: add description layout: default -parent: __archive +parent: _archive --- # ADeus: Open-Source AI Wearable Device diff --git a/docs/index.md b/docs/index.md index 13acc47..f92f85e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,9 +4,9 @@ layout: default nav_order: 1 --- -Welcome contributer, +Welcome dear contributer, -What you are doing here is truly amazing. Open-source contributors are the unsung heroes of technology, the backbone of our modern, OPEN, world. so thank you for being here. +Open-source contributors, like yourself, are the unsung heroes of technology, the backbone of our modern, OPEN, world. so thank you for being here, and know that what you are doing is truly amazing. **Now, let's get started!** diff --git a/docs/troubleshoot.md b/docs/troubleshoot.md index 66dc19f..2c8f6ad 100644 --- a/docs/troubleshoot.md +++ b/docs/troubleshoot.md @@ -1,41 +1,5 @@ --- title: Troubleshoot layout: default -nav_order: 6 +nav_order: 4 --- - -Welcome contributer, - -What you are doing here is truly amazing. Open-source contributors are the unsung heroes of technology, the backbone of our modern, OPEN, world. so thank you for being here. - -**Now, let's get started!** - -## Table of contents - -- [Introduction](#introduction) -- [Getting Started](#getting-started) - - [Set up Supabase](./setup/setup_supabase.md) - - [Set up Web / Mobile App](./setup/setup_app.md) - - [Hardware (Coral AI)](#setup-hardware-coral-ai-device-↗) -- [Resources](#resoucres) -- [How to Contribute](#how-to-contribute) - -First, let's understand how Adeus is built: - -Adeus consists of 3 parts: - -![ADeus diagram](./images/adeus_diagram.png) - -1. **A mobile / web app:** - an interface that lets the user to interact with their assistant and data via chat. - -2. **Hardware device (Currently Coral AI, but soon a Rasberry-Pi Zero W worth $15):** this will be the wearable that will record everything, and send it to the backend to be processed -3. **Supabase :** Our backend, and datavase, where we will process and store data, and interact with LLMs. - 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 us crucial for our mission: A truly open-source, personal AI. - -## Getting Started - -### Resources - -### How to Contribute From 1ade968550561dd103d553fa6565ed026745653a Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 17:46:45 -0500 Subject: [PATCH 21/41] ffs --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index f92f85e..b06d6c3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,9 +6,9 @@ nav_order: 1 Welcome dear contributer, -Open-source contributors, like yourself, are the unsung heroes of technology, the backbone of our modern, OPEN, world. so thank you for being here, and know that what you are doing is truly amazing. +Open-source contributors, like yourself, are the unsung heroes of technology, the backbone of our modern, OPEN, world. -**Now, let's get started!** +So, thank you for being here, and now, **let's get started!** ## Table of contents From 45726d8fb62ae64f9813669ef93c5b7deadbe34d Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 13:15:52 -0500 Subject: [PATCH 22/41] reorder --- docs/archive/archive.md | 4 +- docs/{setup => archive}/setup_coralai.md | 2 +- .../setup_supabase.md => getting_started.md} | 40 +++++++++++++++++-- docs/guides/guides.md | 2 +- .../setup_raspberry_pi_zero.md | 2 +- docs/guides/use_python_recorder.md | 2 +- docs/setup/setup.md | 8 ---- docs/setup/setup_app.md | 35 ---------------- 8 files changed, 44 insertions(+), 51 deletions(-) rename docs/{setup => archive}/setup_coralai.md (99%) rename docs/{setup/setup_supabase.md => getting_started.md} (77%) rename docs/{setup => guides}/setup_raspberry_pi_zero.md (99%) delete mode 100644 docs/setup/setup.md delete mode 100644 docs/setup/setup_app.md diff --git a/docs/archive/archive.md b/docs/archive/archive.md index 43607e7..43ade1c 100644 --- 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 b/docs/archive/setup_coralai.md similarity index 99% rename from docs/setup/setup_coralai.md rename to docs/archive/setup_coralai.md index ba2e6cb..27b4776 100644 --- a/docs/setup/setup_coralai.md +++ b/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 b/docs/getting_started.md similarity index 77% rename from docs/setup/setup_supabase.md rename to docs/getting_started.md index ee91be1..e970f60 100644 --- a/docs/setup/setup_supabase.md +++ b/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: + + + +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 index 74ff246..bfea148 100644 --- 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 b/docs/guides/setup_raspberry_pi_zero.md similarity index 99% rename from docs/setup/setup_raspberry_pi_zero.md rename to docs/guides/setup_raspberry_pi_zero.md index 748d74d..7420b63 100644 --- a/docs/setup/setup_raspberry_pi_zero.md +++ b/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 index 142b1be..b048bb9 100644 --- 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 deleted file mode 100644 index fb8e6cb..0000000 --- a/docs/setup/setup.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -layout: default -title: Setup -nav_order: 2 -has_children: true ---- - -{: .no_toc } diff --git a/docs/setup/setup_app.md b/docs/setup/setup_app.md deleted file mode 100644 index 68f39ac..0000000 --- a/docs/setup/setup_app.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Web & Mobile App -description: add description -layout: default -parent: Setup ---- - -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: - - - -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! From 0b8f199020e2ec9e6e65d384e12d6091f979b7c4 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 13:22:05 -0500 Subject: [PATCH 23/41] abc --- docs/index.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/docs/index.md b/docs/index.md index b06d6c3..3c0c04b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -34,8 +34,20 @@ Adeus consists of 3 parts: 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 us crucial for our mission: A truly open-source, personal AI. -## Getting Started - -### Resources +Next: [Getting Started](https://docs.adeus.ai/getting_started.html) ### How to Contribute + +Adeus is open-source and we welcome contributions. If you're looking to contribute, please: + +- Fork the repository. +- Create a new branch for your feature. +- Add your feature or improvement. +- Send a pull request. + +We appreciate your input! + +### Extra Resources: + +- [Adam going over the entire codebase on livestream](https://www.youtube.com/watch?v=NoKahoN7nYE) +- [Adeus launch original Readme file](https://docs.adeus.ai/archive/launch_readme.html) From bfb6d21c981c0c99eb5ef595eaa98737cfca9748 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 13:24:28 -0500 Subject: [PATCH 24/41] more clean ups --- README.md | 32 +++----------------------------- docs/getting_started.md | 12 ++++++++++-- 2 files changed, 13 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index d463c93..f28b193 100644 --- a/README.md +++ b/README.md @@ -45,33 +45,7 @@ Adeus consists of 3 parts: ![ADeus diagram](docs/images/adeus_diagram.png) -## Getting Started +## Next: -A'ight, let's get this working for you! - -1. Clone the repo: - -```bash -git clone https://github.com/adamcohenhillel/ADeus -``` - -2. #### [Setup Supabase ↗](https://docs.adeus.ai/setup_supabase) - -3. #### [Setup App ↗](https://docs.adeus.ai/setup_app) - -4. #### [Setup Hardware (Coral AI device) ↗](https://docs.adeus.ai/setup/setup_coralai.html) - -- Don't have the hardware device yet? [Read the Docs here](https://docs.adeus.ai) - -## How to Contribute - -Adeus is open-source and we welcome contributions. If you're looking to contribute, please: - -- Fork the repository. -- Create a new branch for your feature. -- Add your feature or improvement. -- Send a pull request. - -We appreciate your input! - -[Read the docs for more information](https://docs.adeus.ai) +- [Getting Started Guide](https://docs.adeus.ai/getting_started.html#1-backend-supabase) +- [How to Contribute?](https://docs.adeus.ai/#how-to-contribute) diff --git a/docs/getting_started.md b/docs/getting_started.md index e970f60..9f2e626 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -6,7 +6,15 @@ nav_order: 2 {: .no_toc } -### 1. Backend (Supabase) +A'ight, let's get this working for you! + +1. Clone the repo: + +```bash +git clone https://github.com/adamcohenhillel/ADeus +``` + +### 2. 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! @@ -55,7 +63,7 @@ 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 +### 3. 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. From fed0173c69710abe5222b9fd453422082f0ff892 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 14:06:04 -0500 Subject: [PATCH 25/41] clean --- docs/getting_started.md | 2 ++ docs/guides/guides.md | 2 ++ docs/guides/setup_raspberry_pi_zero.md | 2 ++ docs/guides/use_python_recorder.md | 2 +- docs/index.md | 2 ++ docs/troubleshoot.md | 2 ++ 6 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/getting_started.md b/docs/getting_started.md index 9f2e626..5d999db 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -4,6 +4,8 @@ title: Getting Started (Set Up) nav_order: 2 --- +# Getting Started (Setup) + {: .no_toc } A'ight, let's get this working for you! diff --git a/docs/guides/guides.md b/docs/guides/guides.md index bfea148..b336114 100644 --- a/docs/guides/guides.md +++ b/docs/guides/guides.md @@ -5,4 +5,6 @@ nav_order: 3 has_children: true --- +# How to Guides + {: .no_toc } diff --git a/docs/guides/setup_raspberry_pi_zero.md b/docs/guides/setup_raspberry_pi_zero.md index 7420b63..618a51c 100644 --- a/docs/guides/setup_raspberry_pi_zero.md +++ b/docs/guides/setup_raspberry_pi_zero.md @@ -5,6 +5,8 @@ layout: default parent: How to Guides --- +# Raspberry Pi Zero W Setup Guide + This guide provides step-by-step instructions for setting up a Raspberry Pi Zero W with the necessary software and configurations for development purposes. ## Prerequisites diff --git a/docs/guides/use_python_recorder.md b/docs/guides/use_python_recorder.md index b048bb9..659daf0 100644 --- a/docs/guides/use_python_recorder.md +++ b/docs/guides/use_python_recorder.md @@ -5,7 +5,7 @@ layout: default parent: How to Guides --- -## Develop without the hardware device: Sound Recording With a Python Script +# Develop without hardware device using a python script Sometimes, when working on the frontend / backend of Adeus, you want an easier and faster feedback loop, one that does not require the use of the physical device. This is exactly what this guide is about. diff --git a/docs/index.md b/docs/index.md index 3c0c04b..4c4e755 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,6 +4,8 @@ layout: default nav_order: 1 --- +# Adeus Documentation + Welcome dear contributer, Open-source contributors, like yourself, are the unsung heroes of technology, the backbone of our modern, OPEN, world. diff --git a/docs/troubleshoot.md b/docs/troubleshoot.md index 2c8f6ad..774f346 100644 --- a/docs/troubleshoot.md +++ b/docs/troubleshoot.md @@ -3,3 +3,5 @@ title: Troubleshoot layout: default nav_order: 4 --- + +# Troubleshoot From bb15d7ac87767ec1403d1b2386d6350a61b60787 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 14:17:52 -0500 Subject: [PATCH 26/41] coral ai --- docs/archive/setup_coralai.md | 13 ++++++++++++- docs/getting_started.md | 6 ++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/archive/setup_coralai.md b/docs/archive/setup_coralai.md index 27b4776..b714991 100644 --- a/docs/archive/setup_coralai.md +++ b/docs/archive/setup_coralai.md @@ -1,10 +1,21 @@ --- -title: Hardware - CoralAI hardware device +title: CoralAI Hardware Device description: add description layout: default parent: _archive --- +# CoralAI Hardware Device + +{: .no_toc } + +## Table of contents + +{: .no_toc .text-delta } + +1. TOC + {:toc} + Setting up hardware #### Prerequisite: ($110) diff --git a/docs/getting_started.md b/docs/getting_started.md index 5d999db..3d418be 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -95,3 +95,9 @@ Enter the four required details, which you should've obtained in the Supabase se 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! + +### 4. Hardware + +- [CoralAI device](https://docs.adeus.ai/archive/setup_coralai.html) +- [Raspberry Pi Zero 2W](https://docs.adeus.ai/guides/setup_raspberry_pi_zero.html) +- ESP32 soon From 732155e632264177e72985b4c66b3098ccc40d54 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 14:23:22 -0500 Subject: [PATCH 27/41] colors --- docs/_sass/custom/setup.scss | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 docs/_sass/custom/setup.scss diff --git a/docs/_sass/custom/setup.scss b/docs/_sass/custom/setup.scss new file mode 100644 index 0000000..9ad05a6 --- /dev/null +++ b/docs/_sass/custom/setup.scss @@ -0,0 +1,5 @@ +$pink-000: #f77ef1; +$pink-100: #f967f1; +$pink-200: #e94ee1; +$pink-300: #dd2cd4; + From 63069a5ffa7a9cbb234f05f1768f2bd16276968e Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 14:35:07 -0500 Subject: [PATCH 28/41] test stuff --- docs/_sass/custom/setup.scss | 5 ----- docs/archive/archive.md | 2 +- docs/archive/launch_readme.md | 8 ++++++++ docs/archive/setup_coralai.md | 3 +-- 4 files changed, 10 insertions(+), 8 deletions(-) delete mode 100644 docs/_sass/custom/setup.scss diff --git a/docs/_sass/custom/setup.scss b/docs/_sass/custom/setup.scss deleted file mode 100644 index 9ad05a6..0000000 --- a/docs/_sass/custom/setup.scss +++ /dev/null @@ -1,5 +0,0 @@ -$pink-000: #f77ef1; -$pink-100: #f967f1; -$pink-200: #e94ee1; -$pink-300: #dd2cd4; - diff --git a/docs/archive/archive.md b/docs/archive/archive.md index 43ade1c..dd2f90b 100644 --- a/docs/archive/archive.md +++ b/docs/archive/archive.md @@ -7,4 +7,4 @@ has_children: true # Archive -{: .no_toc } + diff --git a/docs/archive/launch_readme.md b/docs/archive/launch_readme.md index 50cbbad..e2fb8fe 100644 --- a/docs/archive/launch_readme.md +++ b/docs/archive/launch_readme.md @@ -7,6 +7,14 @@ parent: _archive # ADeus: Open-Source AI Wearable Device +{: .no_toc } + +## Table of contents + +{: .no_toc .text-delta } + +{:toc} + In the upcoming world of AI devices like [Tab](https://mytab.ai/), [Pin](https://hu.ma.ne/aipin), [Rewind](https://www.rewind.ai/pendant), that are with us all the time, **literally** listening to everything we say, and know much about us as our closest friends - it is crucial to be able to own this setup, to own our data, to have this completely open source, managed by the user itself. **This is Adeus, the Open Source AI Wearble device -** and in this repo, you will be guided on how to set up your own! From buying the hardware (~$100, and will be cheaper once we finish the Raspberry PI Zero version) to setting up the backend, the software, and start using your wearable! diff --git a/docs/archive/setup_coralai.md b/docs/archive/setup_coralai.md index b714991..a208b39 100644 --- a/docs/archive/setup_coralai.md +++ b/docs/archive/setup_coralai.md @@ -13,8 +13,7 @@ parent: _archive {: .no_toc .text-delta } -1. TOC - {:toc} +{:toc} Setting up hardware From f0d92bf3d4208fdda6ab723e9990c5532d37e42b Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 14:41:13 -0500 Subject: [PATCH 29/41] first troubleshoot --- docs/archive/archive.md | 2 -- docs/archive/launch_readme.md | 7 +++++-- docs/archive/setup_coralai.md | 7 +++++-- docs/getting_started.md | 9 +++++++++ docs/guides/guides.md | 2 -- docs/troubleshoot.md | 4 ++++ 6 files changed, 23 insertions(+), 8 deletions(-) diff --git a/docs/archive/archive.md b/docs/archive/archive.md index dd2f90b..5143e3a 100644 --- a/docs/archive/archive.md +++ b/docs/archive/archive.md @@ -6,5 +6,3 @@ has_children: true --- # Archive - - diff --git a/docs/archive/launch_readme.md b/docs/archive/launch_readme.md index e2fb8fe..e40148b 100644 --- a/docs/archive/launch_readme.md +++ b/docs/archive/launch_readme.md @@ -13,7 +13,10 @@ parent: _archive {: .no_toc .text-delta } -{:toc} +1. TOC + {:toc} + +--- In the upcoming world of AI devices like [Tab](https://mytab.ai/), [Pin](https://hu.ma.ne/aipin), [Rewind](https://www.rewind.ai/pendant), that are with us all the time, **literally** listening to everything we say, and know much about us as our closest friends - it is crucial to be able to own this setup, to own our data, to have this completely open source, managed by the user itself. @@ -126,7 +129,7 @@ cmake -B out -S . make -C out -j4 ``` -And then, flash it to your device with WIFI_NAME and WIFI_PASSWORD: (Bluetooth pairing is coming soon, see [ticket][https://github.com/adamcohenhillel/AdDeus/issues/8]) +And then, flash it to your device with WIFI_NAME and WIFI_PASSWORD: (Bluetooth pairing is coming soon, see [ticket](https://github.com/adamcohenhillel/AdDeus/issues/8) ```bash python3 coralmicro/scripts/flashtool.py --build_dir out --elf_path out/coralmicro-app --wifi_ssid "" --wifi_psk "" diff --git a/docs/archive/setup_coralai.md b/docs/archive/setup_coralai.md index a208b39..10d467b 100644 --- a/docs/archive/setup_coralai.md +++ b/docs/archive/setup_coralai.md @@ -13,7 +13,10 @@ parent: _archive {: .no_toc .text-delta } -{:toc} +1. TOC + {:toc} + +--- Setting up hardware @@ -74,7 +77,7 @@ cmake -B out -S . make -C out -j4 ``` -And then, flash it to your device with WIFI_NAME and WIFI_PASSWORD: (Bluetooth pairing is coming soon, see [ticket][https://github.com/adamcohenhillel/AdDeus/issues/8]) +And then, flash it to your device with WIFI_NAME and WIFI_PASSWORD: (Bluetooth pairing is coming soon, see [ticket](https://github.com/adamcohenhillel/AdDeus/issues/8) ```bash python3 coralmicro/scripts/flashtool.py --build_dir out --elf_path out/coralmicro-app --wifi_ssid "" --wifi_psk "" diff --git a/docs/getting_started.md b/docs/getting_started.md index 3d418be..294b351 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -8,6 +8,15 @@ nav_order: 2 {: .no_toc } +## Table of contents + +{: .no_toc .text-delta } + +1. TOC + {:toc} + +--- + A'ight, let's get this working for you! 1. Clone the repo: diff --git a/docs/guides/guides.md b/docs/guides/guides.md index b336114..950e1ba 100644 --- a/docs/guides/guides.md +++ b/docs/guides/guides.md @@ -6,5 +6,3 @@ has_children: true --- # How to Guides - -{: .no_toc } diff --git a/docs/troubleshoot.md b/docs/troubleshoot.md index 774f346..587570d 100644 --- a/docs/troubleshoot.md +++ b/docs/troubleshoot.md @@ -5,3 +5,7 @@ nav_order: 4 --- # Troubleshoot + +### building 'hid' extension, error: unknown file type '.pxd' (from 'chid.pxd') + +When setting up your computer for CoralAI development (installing `setup.sh` from the `coralmicro` repo ) you'd need to change the `coralmicro/scripts/requirements.txt` file, making the version of the package `hidapi==0.14.0` (see [issue](https://github.com/google-coral/coralmicro/pull/98)) From 63d8191ee1013f516ef329348933dba55625c653 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 14:44:21 -0500 Subject: [PATCH 30/41] FUCKING TOC --- docs/index.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/index.md b/docs/index.md index 4c4e755..1a99c58 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,22 +6,22 @@ nav_order: 1 # Adeus Documentation +{: .no_toc } + +## Table of contents + +{: .no_toc .text-delta } + +{:toc} + +--- + Welcome dear contributer, Open-source contributors, like yourself, are the unsung heroes of technology, the backbone of our modern, OPEN, world. So, thank you for being here, and now, **let's get started!** -## Table of contents - -- [Introduction](#introduction) -- [Getting Started](#getting-started) - - [Set up Supabase](./setup/setup_supabase.md) - - [Set up Web / Mobile App](./setup/setup_app.md) - - [Hardware (Coral AI)](#setup-hardware-coral-ai-device-↗) -- [Resources](#resoucres) -- [How to Contribute](#how-to-contribute) - First, let's understand how Adeus is built: Adeus consists of 3 parts: From fbe6b0feb3c4cbee2e4091646b4a05496ee8c0f8 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 14:47:13 -0500 Subject: [PATCH 31/41] try dashdashdash --- docs/index.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 1a99c58..c8a3fcb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,12 +16,18 @@ nav_order: 1 --- +## Introduction + Welcome dear contributer, Open-source contributors, like yourself, are the unsung heroes of technology, the backbone of our modern, OPEN, world. So, thank you for being here, and now, **let's get started!** +--- + +## How Adeus is Built + First, let's understand how Adeus is built: Adeus consists of 3 parts: @@ -38,7 +44,9 @@ Adeus consists of 3 parts: Next: [Getting Started](https://docs.adeus.ai/getting_started.html) -### How to Contribute +--- + +## How to Contribute Adeus is open-source and we welcome contributions. If you're looking to contribute, please: @@ -49,7 +57,17 @@ Adeus is open-source and we welcome contributions. If you're looking to contribu We appreciate your input! -### Extra Resources: +--- + +## Extra Resources: - [Adam going over the entire codebase on livestream](https://www.youtube.com/watch?v=NoKahoN7nYE) - [Adeus launch original Readme file](https://docs.adeus.ai/archive/launch_readme.html) + +--- + +## Where to go Next> + +Psst + +--- From c87f225b2bb9a2cc9d3eff831934042c496e24e9 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 14:50:18 -0500 Subject: [PATCH 32/41] try somthing else --- docs/index.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/index.md b/docs/index.md index c8a3fcb..543953d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,13 +8,14 @@ nav_order: 1 {: .no_toc } -## Table of contents - -{: .no_toc .text-delta } - +
+ + Table of contents + + {: .text-delta } +- TOC {:toc} - ---- +
## Introduction From a96f0f96147f5c7110d057bfa2edc76398d8b09a Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 14:56:43 -0500 Subject: [PATCH 33/41] try somthing new --- docs/archive/setup_coralai.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/archive/setup_coralai.md b/docs/archive/setup_coralai.md index 10d467b..62456e9 100644 --- a/docs/archive/setup_coralai.md +++ b/docs/archive/setup_coralai.md @@ -6,15 +6,13 @@ parent: _archive --- # CoralAI Hardware Device - {: .no_toc } ## Table of contents - {: .no_toc .text-delta } 1. TOC - {:toc} +{:toc} --- From ef736c1bde277438088c405cb87c277cb7560075 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 14:59:58 -0500 Subject: [PATCH 34/41] tox --- docs/archive/launch_readme.md | 4 +--- docs/getting_started.md | 4 +--- docs/guides/setup_raspberry_pi_zero.md | 8 ++++++++ docs/guides/use_python_recorder.md | 8 ++++++++ docs/index.md | 12 ++++-------- docs/troubleshoot.md | 8 ++++++++ 6 files changed, 30 insertions(+), 14 deletions(-) diff --git a/docs/archive/launch_readme.md b/docs/archive/launch_readme.md index e40148b..9ddd9bd 100644 --- a/docs/archive/launch_readme.md +++ b/docs/archive/launch_readme.md @@ -6,15 +6,13 @@ parent: _archive --- # ADeus: Open-Source AI Wearable Device - {: .no_toc } ## Table of contents - {: .no_toc .text-delta } 1. TOC - {:toc} +{:toc} --- diff --git a/docs/getting_started.md b/docs/getting_started.md index 294b351..b1fa7d2 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -5,15 +5,13 @@ nav_order: 2 --- # Getting Started (Setup) - {: .no_toc } ## Table of contents - {: .no_toc .text-delta } 1. TOC - {:toc} +{:toc} --- diff --git a/docs/guides/setup_raspberry_pi_zero.md b/docs/guides/setup_raspberry_pi_zero.md index 618a51c..d89c1b8 100644 --- a/docs/guides/setup_raspberry_pi_zero.md +++ b/docs/guides/setup_raspberry_pi_zero.md @@ -6,7 +6,15 @@ parent: How to Guides --- # Raspberry Pi Zero W Setup Guide +{: .no_toc } +## Table of contents +{: .no_toc .text-delta } + +1. TOC +{:toc} + +--- This guide provides step-by-step instructions for setting up a Raspberry Pi Zero W with the necessary software and configurations for development purposes. ## Prerequisites diff --git a/docs/guides/use_python_recorder.md b/docs/guides/use_python_recorder.md index 659daf0..7f25469 100644 --- a/docs/guides/use_python_recorder.md +++ b/docs/guides/use_python_recorder.md @@ -6,7 +6,15 @@ parent: How to Guides --- # Develop without hardware device using a python script +{: .no_toc } +## Table of contents +{: .no_toc .text-delta } + +1. TOC +{:toc} + +--- Sometimes, when working on the frontend / backend of Adeus, you want an easier and faster feedback loop, one that does not require the use of the physical device. This is exactly what this guide is about. #### Setup: diff --git a/docs/index.md b/docs/index.md index 543953d..d1b9984 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,17 +5,13 @@ nav_order: 1 --- # Adeus Documentation - {: .no_toc } -
- - Table of contents - - {: .text-delta } -- TOC +## Table of contents +{: .no_toc .text-delta } + +1. TOC {:toc} -
## Introduction diff --git a/docs/troubleshoot.md b/docs/troubleshoot.md index 587570d..7fa6607 100644 --- a/docs/troubleshoot.md +++ b/docs/troubleshoot.md @@ -5,7 +5,15 @@ nav_order: 4 --- # Troubleshoot +{: .no_toc } +## Table of contents +{: .no_toc .text-delta } + +1. TOC +{:toc} + +--- ### building 'hid' extension, error: unknown file type '.pxd' (from 'chid.pxd') When setting up your computer for CoralAI development (installing `setup.sh` from the `coralmicro` repo ) you'd need to change the `coralmicro/scripts/requirements.txt` file, making the version of the package `hidapi==0.14.0` (see [issue](https://github.com/google-coral/coralmicro/pull/98)) From e281057bffe79986d0868dc1311c6f9afff43ac9 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 15:01:19 -0500 Subject: [PATCH 35/41] a bit more clean up --- docs/getting_started.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/getting_started.md b/docs/getting_started.md index b1fa7d2..289ada5 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -23,7 +23,7 @@ A'ight, let's get this working for you! git clone https://github.com/adamcohenhillel/ADeus ``` -### 2. Backend (Supabase) +## 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! @@ -64,7 +64,8 @@ We will use Supabase as our database (with vector search, pgvector), authenticat If everything worked, we should now be able to start chatting with our personal AI via the app - so let's set that up! -### Setup: Run with Ollama + +**Setup: Run with Ollama** How-to-Guide will be written here soon, but it should be fairly simple with [Ollama](https://ollama.ai/) serve and `ngrok http 11434` @@ -72,7 +73,9 @@ How-to-Guide will be written here soon, but it should be fairly simple with [Oll brew install ngrok/ngrok/ngrok ``` -### 3. Web & Mobile App +--- + +## 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. @@ -103,7 +106,9 @@ 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! -### 4. Hardware +--- + +## Hardware - [CoralAI device](https://docs.adeus.ai/archive/setup_coralai.html) - [Raspberry Pi Zero 2W](https://docs.adeus.ai/guides/setup_raspberry_pi_zero.html) From b221a2b992e30664e3301adbaab4161ca5e26782 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 15:10:30 -0500 Subject: [PATCH 36/41] abc' --- README.md | 8 +++----- TODO => TODO.md | 0 docs/index.md | 10 ++++++++-- 3 files changed, 11 insertions(+), 7 deletions(-) rename TODO => TODO.md (100%) diff --git a/README.md b/README.md index f28b193..3710101 100644 --- a/README.md +++ b/README.md @@ -22,11 +22,9 @@ Adeus is a wearable device that captures what you say and hear in the real world - [Why Adeus?](#why-adeus) - [How Adeus is built](#how-adeus-is-built) -- [Getting Started](#getting-started) - - [Supabase](#setup-supabase-↗) - - [Web / Mobile App](#setup-app-↗) - - [Hardware (Coral AI)](#setup-hardware-coral-ai-device-↗) -- [How to Contribute](#how-to-contribute) +- [Next](#next) + - [Getting Started](https://docs.adeus.ai/getting_started.html) + - [How to Contribute](https://docs.adeus.ai/#how-to-contribute) ## Why Adeus? diff --git a/TODO b/TODO.md similarity index 100% rename from TODO rename to TODO.md diff --git a/docs/index.md b/docs/index.md index d1b9984..6d8345a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -23,6 +23,12 @@ So, thank you for being here, and now, **let's get started!** --- +## Why Adeus? + +In the upcoming world, Personal AI will become an integrated part of our daily lives, they will be with us all the time, and will know much about us as our closest friends - and therefore, with Adeus, we are making sure it is completely open-source, and that you can **own** you own data. + +--- + ## How Adeus is Built First, let's understand how Adeus is built: @@ -63,8 +69,8 @@ We appreciate your input! --- -## Where to go Next> +## Where to go Next -Psst +-> [Getting Started](https://docs.adeus.ai/getting_started.html) --- From 8a8c3304c8240b3700e8b80290725840e00b7f79 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 15:13:07 -0500 Subject: [PATCH 37/41] changes --- docs/getting_started.md | 2 +- docs/index.md | 14 ++++++-------- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/getting_started.md b/docs/getting_started.md index 289ada5..e753a24 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -1,6 +1,6 @@ --- layout: default -title: Getting Started (Set Up) +title: Getting Started (Setup) nav_order: 2 --- diff --git a/docs/index.md b/docs/index.md index 6d8345a..86c020c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -31,8 +31,6 @@ In the upcoming world, Personal AI will become an integrated part of our daily l ## How Adeus is Built -First, let's understand how Adeus is built: - Adeus consists of 3 parts: ![ADeus diagram](./images/adeus_diagram.png) @@ -45,7 +43,11 @@ Adeus consists of 3 parts: 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 us crucial for our mission: A truly open-source, personal AI. -Next: [Getting Started](https://docs.adeus.ai/getting_started.html) +--- + +## Where to go Next + +-> [Getting Started](https://docs.adeus.ai/getting_started.html) --- @@ -60,6 +62,7 @@ Adeus is open-source and we welcome contributions. If you're looking to contribu We appreciate your input! +You can also check the [TODOs](https://github.com/adamcohenhillel/ADeus/blob/main/TODO.md) if you're looking for things you can do --- ## Extra Resources: @@ -69,8 +72,3 @@ We appreciate your input! --- -## Where to go Next - --> [Getting Started](https://docs.adeus.ai/getting_started.html) - ---- From df51bac06222e1a979846e81ef95234847c3a312 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 15:13:56 -0500 Subject: [PATCH 38/41] documentation --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3710101..165a41c 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Adeus is a wearable device that captures what you say and hear in the real world - [Why Adeus?](#why-adeus) - [How Adeus is built](#how-adeus-is-built) -- [Next](#next) +- [Documentation](#documentation) - [Getting Started](https://docs.adeus.ai/getting_started.html) - [How to Contribute](https://docs.adeus.ai/#how-to-contribute) @@ -43,7 +43,7 @@ Adeus consists of 3 parts: ![ADeus diagram](docs/images/adeus_diagram.png) -## Next: +## Documentation: - [Getting Started Guide](https://docs.adeus.ai/getting_started.html#1-backend-supabase) - [How to Contribute?](https://docs.adeus.ai/#how-to-contribute) From d4ea6c446c9bc4c17dc3781f11b4475c9a009b04 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 15:16:54 -0500 Subject: [PATCH 39/41] abc --- docs/troubleshoot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/troubleshoot.md b/docs/troubleshoot.md index 7fa6607..6a34918 100644 --- a/docs/troubleshoot.md +++ b/docs/troubleshoot.md @@ -14,6 +14,6 @@ nav_order: 4 {:toc} --- -### building 'hid' extension, error: unknown file type '.pxd' (from 'chid.pxd') +### error: unknown file type '.pxd' (from 'chid.pxd') When setting up your computer for CoralAI development (installing `setup.sh` from the `coralmicro` repo ) you'd need to change the `coralmicro/scripts/requirements.txt` file, making the version of the package `hidapi==0.14.0` (see [issue](https://github.com/google-coral/coralmicro/pull/98)) From 6c74ef55697d6de40728c14e6cd2d20585261620 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 15:17:19 -0500 Subject: [PATCH 40/41] abc --- docs/troubleshoot.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/troubleshoot.md b/docs/troubleshoot.md index 6a34918..d7ceeef 100644 --- a/docs/troubleshoot.md +++ b/docs/troubleshoot.md @@ -17,3 +17,9 @@ nav_order: 4 ### error: unknown file type '.pxd' (from 'chid.pxd') When setting up your computer for CoralAI development (installing `setup.sh` from the `coralmicro` repo ) you'd need to change the `coralmicro/scripts/requirements.txt` file, making the version of the package `hidapi==0.14.0` (see [issue](https://github.com/google-coral/coralmicro/pull/98)) + + +--- +### add more + +Soon adding more \ No newline at end of file From e46560e4b9f2a32a94d6bf380e36bd51c05cd3d9 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Tue, 13 Feb 2024 15:21:51 -0500 Subject: [PATCH 41/41] clean --- docs/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/index.md b/docs/index.md index 86c020c..06a5613 100644 --- a/docs/index.md +++ b/docs/index.md @@ -63,6 +63,7 @@ Adeus is open-source and we welcome contributions. If you're looking to contribu We appreciate your input! You can also check the [TODOs](https://github.com/adamcohenhillel/ADeus/blob/main/TODO.md) if you're looking for things you can do + --- ## Extra Resources: