Sun Apr 21 14:36:56 PDT 2024

Author: 0x77dev

README.md

@@ -1,48 +1,22 @@
 # Ava
-Self-hosted personal assistant in minutes with built-in Home Assistant integration and great extensibility and customizability.
+Set up your self-hosted personal assistant quickly with integrated Home Assistant support and extensive customization options.
 
-Documentation is available on project website: https://ava.0x77.dev
+For documentation, visit the project website: [ava.0x77.dev](https://ava.0x77.dev)
 
 ![GitHub License](https://img.shields.io/github/license/0x77dev/ava)
 ![Maintenance](https://img.shields.io/maintenance/yes/2024)
 ![GitHub last commit](https://img.shields.io/github/last-commit/0x77dev/ava)
 [![Ship Docker Image](https://github.com/0x77dev/ava/actions/workflows/docker-image.yaml/badge.svg)](https://github.com/0x77dev/ava/actions/workflows/docker-image.yaml)
 
-
 ## Features
 
-- **Supports almost all major LLMs**: Support for OpenAI, Anthropic, and Ollama out of the box.
-- **Home Assistant Integration**: Ava can control your Home Assistant devices and answer questions about your entities.
-- **Extensible _(work in progress)_**: Ava is built with extensibility in mind. You can easily add new skills using custom HTTP endpoints.
-- **Customizable**: Great level of customizability with almost everything being configurable using environment variables.
-- **Fully private**: Ava is self-hosted, so you have full control over your data.
-- **OpenAI compatible endpoints**: Chat with your Ava using OpenAI compatible chat completion endpoint.
-- **Home Assistant addons**: Install Ava and Ollama as a Home Assistant addons with a couple of clicks.
-- **Dockerized**: Ava is available as a Docker image for both amd64 and aarch64, so you can manually spin it up in minutes.
-
-## Home Assistant Installation
-
-### Addons Repository
-
-[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https://github.com/0x77dev/ava)
-
-- [**Ollama**](./ollama): The easiest way to get up and running with large language models locally
-- [**Ava Server**](./server)
-
-Learn more about configuring the addons on the [project website](https://ava.0x77.dev).
-
-### Custom component
-
-#### HACS
-
-[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=0x77dev&repository=ava&category=integration)
-
-#### Manual
-
-Copy the [`custom_components/ava`](./custom_components/ava) folder to your `/config/custom_components` Home Assistant folder.
-
-You can download the custom component zip directly using [GitZip](https://kinolien.github.io/gitzip/?download=https://github.com/0x77dev/ava/tree/main/custom_components/ava).
-
-Learn more about configuring the custom component on the [project website](https://ava.0x77.dev).
-
+-  **Supports major LLMs**: OpenAI, Anthropic, and Ollama supported by default.
+-  **Home Assistant Integration**: Control Home Assistant devices and get entity information.
+-  **Extensible _(work in progress)_**: Easily add new skills via custom HTTP endpoints.
+-  **Customizable**: Highly configurable through environment variables.
+-  **Fully private**: Can be self-hosted for complete data control.
+-  **OpenAI compatible endpoints**: Chat with Ava using OpenAI-compatible chat completion.
+-  **Home Assistant addons**: Install Ava and Ollama as Home Assistant add-ons.
+-  **Dockerized**: Available as Docker images for amd64 and aarch64.
 
+See the [documentation](https://ava.0x77.dev) for more information on how to get started.

docs/content/2.installation/1.haos.md

@@ -0,0 +1,34 @@
+---
+title: Home Assistant OS
+description: Get Ava up and running on your Home Assistant OS instance
+---
+
+
+## Home Assistant Installation
+
+### Add-ons
+
+[![Open Home Assistant instance and add repository](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https://github.com/0x77dev/ava)
+
+-  **Ollama**: The easiest way to get up and running with large language models locally.
+-  **Ava Server**: Ava server for Home Assistant integration and OpenAI chat completion compatible endpoint.
+
+Just install the addons from the repository and configure them as needed.
+
+Ava server has default configuration for Anthropic as LLM and Ollama add-on as embeddings provider.
+
+### Custom component
+
+#### HACS
+
+[![Open Home Assistant and HACS repository](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=0x77dev&repository=ava&category=integration)
+
+#### Manual
+
+Copy the [`custom_components/ava`](./custom_components/ava) folder to `/config/custom_components` in Home Assistant.
+
+Download the custom component zip via [GitZip](https://kinolien.github.io/gitzip/?download=https://github.com/0x77dev/ava/tree/main/custom_components/ava).
+
+#### Configuration
+
+Set up the Ava integration in Home Assistant and configure the server URL and API key. It comes with default configuration for Home Assistant Ava Server add-on.

docs/content/2.installation/2.standalone.md

@@ -0,0 +1,6 @@
+---
+title: Standalone
+description: Get Ava up and running on any machine with Docker
+---
+
+TODO

docs/content/2.installation/_dir.yml

@@ -0,0 +1 @@
+title: Installation

docs/content/3.configuration/1.index.md

@@ -0,0 +1,5 @@
+---
+title: Configuration
+---
+
+TODO

docs/content/3.configuration/_dir.yml

@@ -0,0 +1 @@
+title: Configuration

docs/content/index.yml

@@ -39,26 +39,27 @@ features:
   items:
     # TODO: add "to" links
     - title: 'Supports almost all major LLMs'
-      description: 'Support for OpenAI, Anthropic, and Ollama out of the box.'
+      description: 'OpenAI, Anthropic, and Ollama supported by default'
       icon: 'i-ph-brain-duotone'
       target: '_blank'
-    - title: 'Built-in Home Assistant integration'
-      description: 'Built-in Home Assistant integration for easy setup and control of your smart home.'
+    - title: 'Home Assistant integration'
+      description: 'Control Home Assistant devices and get entity information. Add-ons and HACS repo for ease of use'
       icon: 'i-simple-icons-homeassistant'
       target: '_blank'
-    - title: 'Extensible using webhooks'
-      description: 'Exposes ability for assistant to perform actions using simple HTTP calls.'
+    - title: 'Extensible'
+      wip: true
+      description: 'Easily add new skills via custom HTTP endpoints'
       icon: 'i-heroicons-sparkles-20-solid'
       target: '_blank'
     - title: 'Customizable'
-      description: 'Great level of customizability with almost evebything being configurable using environment variables.'
+      description: 'Highly configurable through environment variables'
       icon: 'i-ph-compass-tool-duotone'
       target: '_blank'
     - title: 'Fully private'
-      description: 'All of the tools and services for Ava to work can be self-hosted and isolated from the internet.'
+      description: 'All of the tools and services for Ava to work can be self-hosted and isolated from the internet'
       icon: 'i-ph-security-camera-duotone'
       target: '_blank'
     - title: 'OpenAI compatible endpoints'
-      description: 'Chat with your Ava using OpenAI compatible endpoints.'
+      description: 'Chat with your Ava using OpenAI compatible endpoints'
       icon: 'i-simple-icons-openai'
       target: '_blank'