Add theme to docs, and improve content

.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
+    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
+        working-directory: ./docs
+        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

.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/

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)
+- [Documentation](#documentation)
+  - [Getting Started](https://docs.adeus.ai/getting_started.html)
+  - [How to Contribute](https://docs.adeus.ai/#how-to-contribute)
 
 ## Why Adeus?
 
@@ -45,33 +43,7 @@ Adeus consists of 3 parts:
 
 ![ADeus diagram](docs/images/adeus_diagram.png)
 
-## Getting Started
+## Documentation:
 
-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)

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

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

docs/_config.yml

@@ -0,0 +1,19 @@
+title: Adeus Documentation
+description: Open Source AI Wearable device
+theme: just-the-docs
+
+url: https://docs.adeus.ai
+
+aux_links:
+  Github: https://github.com/adamcohenhillel/ADeus
+
+aux_links_new_tab: true
+
+nav_external_links:
+  - title: Discord
+    url: https://discord.gg/N5c6KXBgWW
+    opens_in_new_tab: true
+
+  - title: GitHub
+    url: https://github.com/adamcohenhillel/ADeus
+    opens_in_new_tab: true

docs/archive/archive.md

@@ -0,0 +1,8 @@
+---
+layout: default
+title: _archive
+nav_order: 5
+has_children: true
+---
+
+# Archive

docs/archive/launch_readme.md

@@ -1,4 +1,20 @@
+---
+title: Launch Readme Version
+description: add description
+layout: default
+parent: _archive
+---
+
 # ADeus: Open-Source AI Wearable Device
+{: .no_toc }
+
+## Table of contents
+{: .no_toc .text-delta }
+
+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.
 
@@ -15,7 +31,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 +48,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 +85,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):
 
@@ -111,7 +127,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_NAME>" --wifi_psk "<WIFI_PASSWORD>"
@@ -175,4 +191,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)

docs/how-to/setup_coralai.md → docs/archive/setup_coralai.md

@@ -1,8 +1,23 @@
 ---
-title: Setting up the 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)
 
 1. [Dev Board Micro](https://coral.ai/products/dev-board-micro/) ($80)
@@ -18,7 +33,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):
 
@@ -60,7 +75,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_NAME>" --wifi_psk "<WIFI_PASSWORD>"