Skip to content

Commit da312c9

Browse files
committed
Update docs
1 parent 11adc7f commit da312c9

2 files changed

Lines changed: 46 additions & 14 deletions

File tree

docs/smart-home/dashboards.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
tags:
3+
- dashboard
4+
- automated
5+
---
6+
17
# Home Assistant Dashboards
28

39
This documentation is automatically generated from the live configuration.

docs/system_manual/setup_guide.md

Lines changed: 40 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# EvisHomeLab: Documentation System Manual
22

3-
**Version:** 3.8
3+
**Version:** 3.9
44
**Philosophy:** Agentic CMDB (Configuration Management Database)
55
**Strategy:** "Detached Docs" (Private Config -> Public Documentation)
66

@@ -178,18 +178,7 @@ These settings are stored on your laptop, not the server, so you must set them a
178178

179179
## PART C: Daily Operations (The Workflow)
180180

181-
### 1. Visual Assets Standard
182-
When adding images, you **must** use the correct naming convention so the automation scripts can find them.
183-
184-
| Type | Folder Location | Naming Convention |
185-
| :--- | :--- | :--- |
186-
| **Dashboards** | `docs/assets/images/dashboards/` | `view_[path].png` (e.g. `view_kitchen.png`) |
187-
| **Packages** | `docs/assets/images/packages/` | `[package_name].png` (e.g. `heating.png`) |
188-
| **General** | `docs/assets/images/brand/` | Free choice |
189-
190-
**Note:** The dashboard script `ag_regenerate_dashboards.py` automatically generates links assuming the `view_[path].png` format. If your image is missing, the link will be broken on the site.
191-
192-
### 2. The Full Maintenance Cycle
181+
### 1. The Full Maintenance Cycle
193182
1. **Update Tools:** `python ag_update_docs.py`
194183
2. **Regenerate Dashboards:** `python ag_regenerate_dashboards.py`
195184
3. **Publish:**
@@ -200,7 +189,28 @@ When adding images, you **must** use the correct naming convention so the automa
200189
git push
201190
```
202191

203-
### 3. The Agent Prompts
192+
### 2. The AI Architect Workflow (Resume Work)
193+
**When starting a new Chat Session with an AI Model:**
194+
Paste this prompt to "hydrate" the AI with the project context:
195+
196+
> "I am resuming work on the **EvisHomeLab** project.
197+
>
198+
> **Task:**
199+
> 1. Read the attached **`docs_site/AI_CONTEXT.md`** to load your Persona, Architecture constraints, and Safety Rules.
200+
> 2. Read the attached **`docs_site/docs/system_manual/setup_guide.md`** to understand the operational workflows.
201+
>
202+
> **Action:** Confirm you have loaded the context and are ready to assist with maintaining the CMDB."
203+
204+
### 3. Visual Assets Standard
205+
When adding images, you **must** use the correct naming convention so the automation scripts can find them.
206+
207+
| Type | Folder Location | Naming Convention |
208+
| :--- | :--- | :--- |
209+
| **Dashboards** | `docs/assets/images/dashboards/` | `view_[path].png` (e.g. `view_kitchen.png`) |
210+
| **Packages** | `docs/assets/images/packages/` | `[package_name].png` (e.g. `heating.png`) |
211+
| **General** | `docs/assets/images/brand/` | Free choice |
212+
213+
### 4. The Agent Prompts
204214

205215
**Task: Update Single Package (Focus Mode)**
206216
> "Update the documentation for the **[PACKAGE_NAME]** package.
@@ -210,6 +220,22 @@ When adding images, you **must** use the correct naming convention so the automa
210220
> 4. **Dashboard Links:** Scan `.storage/lovelace_dashboards` for cards using these entities and embed them.
211221
> 5. **Visuals:** Look in `assets/images/packages/` for an image named `[PACKAGE_NAME].png` or `[PACKAGE_NAME]_card.png`. If found, display it. If not, use a placeholder."
212222

223+
**Task: Generate All Package Documentation (Full Scan)**
224+
> "Perform a deep architectural scan of my `packages/` directory.
225+
> **For EVERY YAML file found, create a corresponding Markdown file in `docs_site/docs/smart-home/packages/` containing:**
226+
> 1. **Frontmatter:** Add tags `['package', 'automated']`.
227+
> 2. **Executive Summary:** What does this package do?
228+
> 3. **Architecture Diagram:** Generate a `mermaid` sequence diagram of the logic.
229+
> 4. **The Code:** Embed the YAML content in a code block (Redact secrets!).
230+
> 5. **Dashboard Connections:** Scan `.storage/lovelace_dashboards`. Identify cards that control entities from this package and embed their configuration.
231+
> 6. **Visuals:** Insert a placeholder link for a screenshot (e.g., `![View](assets/images/heating.png)`).
232+
> Finally, update `mkdocs.yml` navigation."
233+
234+
**Task: Update Structure Documentation**
235+
> "Update `docs_site/docs/smart-home/structure.md`.
236+
> 1. Re-scan the root directory and update the file tree structure description (Folders first, then files).
237+
> 2. Read `configuration.yaml` and update the commented code block explanation."
238+
213239
**Task: Enable Tags & Tag Cloud**
214240
> "Edit `docs_site/mkdocs.yml`.
215241
> 1. Under `plugins:`, add `- tags`.

0 commit comments

Comments
 (0)