Skip to content

Commit

Permalink
discord stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
adamcohenhillel committed Feb 12, 2024
1 parent 6cc01f7 commit f908c06
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 3 deletions.
4 changes: 4 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/archive/archive.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Archive
nav_order: 6
title: __archive
nav_order: 5
has_children: true
---

Expand Down
2 changes: 1 addition & 1 deletion docs/archive/launch_readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Launch Readme Version
description: add description
layout: default
parent: Archive
parent: __archive
---

# ADeus: Open-Source AI Wearable Device
Expand Down
41 changes: 41 additions & 0 deletions docs/troubleshoot.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit f908c06

Please sign in to comment.