mirror of
https://github.com/CCOSTAN/Home-AssistantConfig.git
synced 2025-12-03 03:21:47 +00:00
Update README files across configuration directories to enhance navigation and clarity
- Added "You are here" sections to various README files in the config directory, improving user orientation. - Updated links in the main README to reflect new structure and provide direct access to configuration readmes. - Enhanced descriptions in the automation, packages, scenes, scripts, and sounds directories for better usability. https://github.com/CCOSTAN/Home-AssistantConfig/pull/1535
This commit is contained in:
@@ -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)
|
||||
|
||||

|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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)
|
||||
|
||||

|
||||
|
||||
@@ -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).
|
||||
|
||||
@@ -17,9 +17,10 @@
|
||||
|
||||
</div>
|
||||
|
||||
Small, reusable trigger packages<65>button presses, state trackers, and helper flows that other packages import.
|
||||
Small, reusable trigger packages<65>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)
|
||||
|
||||

|
||||
|
||||
@@ -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)
|
||||
|
||||

|
||||
|
||||
@@ -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)
|
||||
|
||||

|
||||
@@ -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 <20>all interior lights off<66> helper. |
|
||||
| [interior_off.yaml](interior_off.yaml) | One-call <20>all interior lights off<66> helper. |
|
||||
|
||||
### Tips
|
||||
- Keep scripts generic<69>route data via `data:`/`variables:` and reuse everywhere.
|
||||
- Keep scripts generic<69>route data via `data:`/`variables:` and reuse everywhere.
|
||||
- If you copy a script, rename any `alias` and `id` fields to avoid duplicates.
|
||||
|
||||
|
||||
|
||||
@@ -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)
|
||||
|
||||

|
||||
|
||||
Reference in New Issue
Block a user