You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AI_CONTEXT.md
+18-2Lines changed: 18 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,7 +59,23 @@ When creating Python or Shell scripts for this project:
59
59
## 5. Deployment Logic
60
60
61
61
* The site is built via **GitHub Actions**.
62
-
63
62
* We must push changes from the `docs_site/` directory to trigger a build.
64
-
65
63
***CNAME:** Ensure `docs/CNAME` exists and contains `www.evishome.com`.
64
+
65
+
## 6. Project History & Architectural Decisions (ADRs)
66
+
67
+
*This section captures 'Silent Knowledge' and lessons learned.*
68
+
69
+
1.**ADR-001: Detached Documentation:**
70
+
***Decision:** We use two separate Git repositories. The root `/config` is local-only to prevent accidental secret leakage. Only `docs_site/` is pushed to GitHub.
71
+
72
+
2.**ADR-002: Dashboard Generation via Python:**
73
+
***Failure:** Using LLMs to "rewrite" JSON dashboards often results in broken YAML or single-line dumps.
74
+
***Decision:** We rely on `ag_regenerate_dashboards.py`. This script forces `default_flow_style=False` to ensure readable, block-style YAML output. It also enforces privacy redaction programmatically.
75
+
76
+
3.**ADR-003: Samba & Git Ownership:**
77
+
***Issue:** Windows clients accessing HA via Samba see "Dubious Ownership" errors because the files are owned by `root` on the server.
78
+
***Fix:** We enforce `git config --global --add safe.directory '*'` on all dev machines.
79
+
80
+
4.**ADR-004: MkDocs Material Features:**
81
+
***Decision:** We explicitly enable `navigation.indexes` (folders act as pages) and `admonition` extensions to support high-quality CMDB layouts.
**Strategy:** "Detached Docs" (Private Config -> Public Documentation)
6
6
@@ -15,7 +15,7 @@ This project automates the documentation of a Home Assistant Smart Home and Home
15
15
16
16
---
17
17
18
-
##PART A: One-Time Initialization (The Genesis)
18
+
# PART A: One-Time Initialization (The Genesis)
19
19
20
20
**⚠️ STOP:** Only perform these steps if you are setting up the system **for the very first time** on a fresh Home Assistant server. If the system already exists and you just want to connect a new laptop, skip to **PART B**.
21
21
@@ -131,7 +131,7 @@ git push -u origin main
131
131
132
132
---
133
133
134
-
##PART B: Workstation Setup (Adding Laptops)
134
+
# PART B: Workstation Setup (Adding Laptops)
135
135
136
136
**✅ START HERE:** If the system is already running and you want to work on it from a new computer (Laptop 2, 3, etc.).
137
137
@@ -173,7 +173,7 @@ These settings are stored on your laptop, not the server, so you must set them a
173
173
174
174
---
175
175
176
-
##PART C: Daily Operations (The Workflow)
176
+
# PART C: Daily Operations (The Workflow)
177
177
178
178
### 1. The Full Maintenance Cycle (Recommended Routine)
179
179
Run this sequence to update everything cleanly.
@@ -212,14 +212,25 @@ You must "hydrate" the AI with the project context so it can act as the Architec
212
212
> 5. **Visuals:** Insert a placeholder link for a screenshot (e.g., ``).
213
213
> Finally, update `mkdocs.yml` navigation."
214
214
215
+
**Task: Web Design & Image Management**
216
+
>"I have added new images to `docs_site/docs/assets/images/` and I want to update the styling.
217
+
>
218
+
> **Task 1 (Images):** Scan the `images` folder. Update the Markdown files to replace placeholder text with the actual image links.
219
+
>
220
+
> **Task 2 (CSS):** Check `docs_site/docs/assets/css/custom.css`. Ensure it is linked in `mkdocs.yml`. If I ask for color changes, apply them to the CSS variables."
0 commit comments