diff --git a/README.md b/README.md index 4ed68e2a..619072cb 100755 --- a/README.md +++ b/README.md @@ -19,8 +19,9 @@ Live, personal Home Assistant configuration shared for **browsing and inspiration**. This is not a turnkey clone-and-run setup; borrow ideas, adapt entity IDs/secrets, and test in your own environment. ### Quick navigation +- You are here: `/` (root repo guide) - [Blog](https://www.vcloudinfo.com) | [Issues](https://github.com/CCOSTAN/Home-AssistantConfig/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) | [Diagram](config/www/custom_ui/floorplan/images/branding/Bear-Stone-Docker-Diagram.jpg) | [YouTube](https://youtube.com/vCloudInfo) -- Config highlights: `config/packages`, `config/automation`, `config/script`, `config/scene`, `config/templates`, `config/www` +- Config readmes: [Config index](config/README.md) | [Packages](config/packages/README.md) | [Automations](config/automation/README.md) | [Scripts](config/script/README.md) | [Scenes](config/scene/README.md) | [Sounds](config/sounds/README.md) | [Package triggers](config/packages/triggers/README.md) - Gear & affiliate catalog: see `legacy-readme.md` (full device list with links) ![Home Assistant header](https://i.imgur.com/vjDH1LJ.png) diff --git a/config/README.md b/config/README.md index 95c4aa9f..e01caf2a 100755 --- a/config/README.md +++ b/config/README.md @@ -19,6 +19,7 @@ Live view of the `config/` directory my production Home Assistant instance loads every night. Use this README as a map when you want to jump directly into the most interesting packages, automations, and supporting assets. ### Quick navigation +- You are here: `config/` (configuration root) - [Repo overview](../README.md) | [Blog](https://www.vcloudinfo.com) | [Issues](https://github.com/CCOSTAN/Home-AssistantConfig/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) | [Diagram](config/www/custom_ui/floorplan/images/branding/Bear-Stone-Docker-Diagram.jpg) | [YouTube](https://youtube.com/vCloudInfo) - Directory highlights: [packages](packages), [automation](automation), [script](script), [scene](scene), [templates](templates), [www](www), [custom_components](custom_components) - Gear & affiliate catalog: see [../legacy-readme.md](../legacy-readme.md) for the complete shopping list diff --git a/config/automation/README.md b/config/automation/README.md index 4dee4553..8c70b583 100755 --- a/config/automation/README.md +++ b/config/automation/README.md @@ -20,6 +20,7 @@ Event-driven automations that sit outside the self-contained packages. These tie motion, presence, weather, and time-of-day signals together for real rooms and routines. ### Quick navigation +- You are here: `config/automation/` (standalone automations) - [Repo overview](../../README.md) | [Config index](../README.md) | [Packages](../packages) | [Scripts](../script) | [Scenes](../scene) ![Home Assistant header](https://i.imgur.com/vjDH1LJ.png) diff --git a/config/packages/README.md b/config/packages/README.md index 7958b3d4..6e648b5a 100755 --- a/config/packages/README.md +++ b/config/packages/README.md @@ -19,6 +19,7 @@ Live collection of plug-and-play Home Assistant packages. Each YAML file in this folder bundles sensors, helpers, automations, scripts, and Lovelace assets needed for a specific subsystem so you can drop it into `configuration.yaml` with a single `packages:` include. ### Quick navigation +- You are here: `config/packages/` (self-contained packages) - [Repo overview](../../README.md) | [Config index](../README.md) | [Automations](../automation) | [Scripts](../script) | [Scenes](../scene) | [Templates](../templates) | [Package triggers](triggers) | [YouTube](https://youtube.com/vCloudInfo) | [Blog](https://www.vcloudinfo.com) - Disabled/staging packages follow the `.disabled` or `.NOTWORKING` suffix; remove it after you update credentials or hardware. - Looking for the full gear list? See [../legacy-readme.md](../../legacy-readme.md). diff --git a/config/packages/triggers/README.md b/config/packages/triggers/README.md index b771e69c..1fa33e0e 100755 --- a/config/packages/triggers/README.md +++ b/config/packages/triggers/README.md @@ -17,9 +17,10 @@ -Small, reusable trigger packages—button presses, state trackers, and helper flows that other packages import. +Small, reusable trigger packages�button presses, state trackers, and helper flows that other packages import. ### Quick navigation +- You are here: `config/packages/triggers/` (shared trigger examples) - [Repo overview](../../../README.md) | [Config index](../../README.md) | [Packages home](..) | [Automation home](../../automation) ![Home Assistant header](https://i.imgur.com/vjDH1LJ.png) diff --git a/config/scene/README.md b/config/scene/README.md index 2e2af100..261b89e1 100755 --- a/config/scene/README.md +++ b/config/scene/README.md @@ -20,6 +20,7 @@ Reusable lighting and ambiance presets. Automations and scripts call these scenes to avoid duplicating brightness/color targets everywhere. ### Quick navigation +- You are here: `config/scene/` (scenes library) - [Repo overview](../../README.md) | [Config index](../README.md) | [Scripts](../script) | [Automations](../automation) ![Home Assistant header](https://i.imgur.com/vjDH1LJ.png) diff --git a/config/script/README.md b/config/script/README.md index 345d5da5..7d89b56f 100755 --- a/config/script/README.md +++ b/config/script/README.md @@ -20,6 +20,7 @@ Reusable scripts that other automations call for notifications, lighting, and safety responses. Pass variables in; let the script do the heavy lifting. ### Quick navigation +- You are here: `config/script/` (scripts library) - [Repo overview](../../README.md) | [Config index](../README.md) | [Automations](../automation) | [Scenes](../scene) | [Blog: Speech engine video](https://www.vcloudinfo.com/2018/12/breaking-down-my-home-assistant-volume.html) ![Home Assistant header](https://i.imgur.com/vjDH1LJ.png) @@ -30,10 +31,10 @@ Reusable scripts that other automations call for notifications, lighting, and sa | [notify_engine.yaml](notify_engine.yaml) | Single entrypoint for rich push notifications. | | [speech_engine.yaml](speech_engine.yaml) | TTS/announcement orchestration with templated speech. | | [monthly_color_scene.yaml](monthly_color_scene.yaml) | Seasonal lighting scenes used across automations. | -| [interior_off.yaml](interior_off.yaml) | One-call “all interior lights off” helper. | +| [interior_off.yaml](interior_off.yaml) | One-call �all interior lights off� helper. | ### Tips -- Keep scripts generic—route data via `data:`/`variables:` and reuse everywhere. +- Keep scripts generic�route data via `data:`/`variables:` and reuse everywhere. - If you copy a script, rename any `alias` and `id` fields to avoid duplicates. diff --git a/config/sounds/README.md b/config/sounds/README.md index d64df4e7..f75c3989 100755 --- a/config/sounds/README.md +++ b/config/sounds/README.md @@ -20,6 +20,7 @@ Audio assets (alert tones, chimes, TTS snippets) used by automations and scripts. ### Quick navigation +- You are here: `config/sounds/` (audio assets) - [Repo overview](../../README.md) | [Config index](../README.md) | [Automations](../automation) | [Scripts](../script) ![Home Assistant header](https://i.imgur.com/vjDH1LJ.png)