Skip to content

Commit

Permalink
add the info section
Browse files Browse the repository at this point in the history
  • Loading branch information
adamcohenhillel committed May 1, 2024
1 parent cca54e2 commit aa7ee28
Show file tree
Hide file tree
Showing 12 changed files with 109 additions and 28 deletions.
15 changes: 12 additions & 3 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,24 @@ logo: "/images/logo.png"
favicon_ico: "/images/favicon.ico"

collections:
guides:
get_started:
permalink: "/:collection/:path/"
output: true
assembly:
permalink: "/:collection/:path/"
output: true
info:
permalink: "/:collection/:path/"
output: true
nav_fold: false

just_the_docs:
collections:
guides:
get_started:
name: Get Started
assembly:
name: Assembly
info:
name: Info

description: Open Source AI Wearable device
theme: just-the-docs
Expand Down
23 changes: 23 additions & 0 deletions docs/_get_started/Introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
layout: default
title: Introduction
nav_order: 1
---

# Introduction

Friend is an AI wearable device that records everything you say, giving you proactive feedback and advice. Use these docs to unlock the full potential of Friend and build using the power of recall.

![Friend Image](../images/mainbanner.jpeg)

## Features

- Real-Time AI Audio Processing: Leverage powerful on-device AI capabilities for real-time audio analysis.

- Low-powered Bluetooth: Capture audio for 24h+ on a small button battery

- Open-Source Software: Access and contribute to the pin’s software stack, designed with openness and community collaboration in mind. -Wearable Design: Experience unparalleled convenience with ergonomic and lightweight design, perfect for everyday wear

## How it works

The first step to world-class documentation is setting up your editing environments.
23 changes: 23 additions & 0 deletions docs/_get_started/Setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
layout: default
title: Introduction
nav_order: 2
---

# Setup

Follow these steps to get started with your Friend in under 5 minutes.

![Friend Image](../images/mainbanner.jpeg)

## Features

- Real-Time AI Audio Processing: Leverage powerful on-device AI capabilities for real-time audio analysis.

- Low-powered Bluetooth: Capture audio for 24h+ on a small button battery

- Open-Source Software: Access and contribute to the pin’s software stack, designed with openness and community collaboration in mind. -Wearable Design: Experience unparalleled convenience with ergonomic and lightweight design, perfect for everyday wear

## How it works

The first step to world-class documentation is setting up your editing environments.
17 changes: 0 additions & 17 deletions docs/_guides/example.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/_guides/guides.md

This file was deleted.

20 changes: 20 additions & 0 deletions docs/_info/Contribution.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
layout: default
title: Introduction
nav_order: 1
---

# Contribution

We welcome contributions from the community! If you are interested in improving Friend, our current biggest goal is to combine both apps together (AppStandalone with AppWithWearable)

- Standalone App brings great prompts and rich structure

- AppWithWearable brings simple bluetooth connecting functionality

![Friend Image](../images/discord_community_banner.png)

### Join a community of builders

[Based Hardware Discord](https://discord.gg/kEXXsnb5b3){: .btn .btn-purple }
[Our official repository](https://github.com/BasedHardware/Friend){: .btn .btn-green }
13 changes: 13 additions & 0 deletions docs/_info/Disclaimer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
layout: default
title: Disclaimer
nav_order: 4
---

# Disclaimer

Please note that the Friend is a prototype project and is provided “as is”, without warranty of any kind. Use of the device should comply with all local laws and regulations concerning privacy and data protection.

![discord_community_banner](../images/disclaimer.png)

Thank you for your interest in Friend, the open-source AI wearable. We’re excited to see what you’ll build with it!
9 changes: 9 additions & 0 deletions docs/_info/License.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
layout: default
title: License
nav_order: 3
---

# License

Friend is available under MIT License
9 changes: 9 additions & 0 deletions docs/_info/Support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
layout: default
title: Support
nav_order: 2
---

# Support

For open-source support, please open an issue on GitHub and/or ask in our Discord Community. For commercial support, license inquiries, or any other questions, please contact us directly at [team@basedhardware.com](mailto://team@basedhardware.com.)
Binary file added docs/images/disclaimer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/discord_community_banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/mainbanner.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit aa7ee28

Please sign in to comment.