Skip to content

Commit 6220814

Browse files
committed
Update docs
1 parent d4ec288 commit 6220814

2 files changed

Lines changed: 34 additions & 7 deletions

File tree

AI_CONTEXT.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,23 @@ When creating Python or Shell scripts for this project:
5959
## 5. Deployment Logic
6060

6161
* The site is built via **GitHub Actions**.
62-
6362
* We must push changes from the `docs_site/` directory to trigger a build.
64-
6563
* **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.

docs/system_manual/setup_guide.md

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

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

@@ -15,7 +15,7 @@ This project automates the documentation of a Home Assistant Smart Home and Home
1515

1616
---
1717

18-
## PART A: One-Time Initialization (The Genesis)
18+
# PART A: One-Time Initialization (The Genesis)
1919

2020
**⚠️ 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**.
2121

@@ -131,7 +131,7 @@ git push -u origin main
131131

132132
---
133133

134-
## PART B: Workstation Setup (Adding Laptops)
134+
# PART B: Workstation Setup (Adding Laptops)
135135

136136
**✅ START HERE:** If the system is already running and you want to work on it from a new computer (Laptop 2, 3, etc.).
137137

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

174174
---
175175

176-
## PART C: Daily Operations (The Workflow)
176+
# PART C: Daily Operations (The Workflow)
177177

178178
### 1. The Full Maintenance Cycle (Recommended Routine)
179179
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
212212
> 5. **Visuals:** Insert a placeholder link for a screenshot (e.g., `![View](assets/images/heating.png)`).
213213
> Finally, update `mkdocs.yml` navigation."
214214

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."
221+
215222
**Task: Update Structure Documentation**
216223
> "Update `docs_site/docs/smart-home/structure.md`.
217224
> 1. Re-scan the root directory and update the file tree structure description (Folders first, then files).
218225
> 2. Read `configuration.yaml` and update the commented code block explanation."
219226

227+
**Task: Convert Dashboard to YAML (Python Method)**
228+
> "Run `python ag_regenerate_dashboards.py` in the terminal.
229+
> This script will read the raw JSON dashboards, apply strict privacy redaction, convert everything to clean YAML, and update `dashboards.md`."
230+
220231
---
221232

222-
## PART D: Troubleshooting
233+
# PART D: Troubleshooting
223234

224235
### 1. `mkdocs.yml` is Red
225236
* **Status:** False Positive. Ignore it.

0 commit comments

Comments
 (0)