Skip to content

Commit 080f8db

Browse files
committed
Update System Manual to 5.5
1 parent 01b5e3e commit 080f8db

1 file changed

Lines changed: 31 additions & 42 deletions

File tree

docs/system_manual/setup_guide.md

Lines changed: 31 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
1+
<!-- VALIDATION_CHECKLIST: [
2+
"## PART A: One-Time Initialization",
3+
"## PART B: Workstation Setup",
4+
"## PART C: Daily Operations",
5+
"The AI Architect Workflow",
6+
"Visual Assets Standard",
7+
"Task: Web Design & Image Management",
8+
"Task: Update Single Package",
9+
"Task: Generate All Package Documentation",
10+
"ag_regenerate_dashboards.py",
11+
"## PART E: Tool Reference",
12+
"## PART F: Troubleshooting"
13+
] -->
114
# EvisHomeLab: Documentation System Manual
215

3-
**Version:** 4.1
16+
**Version:** 5.1
417
**Philosophy:** Agentic CMDB (Configuration Management Database)
518
**Strategy:** "Detached Docs" (Private Config -> Public Documentation)
619

@@ -178,48 +191,15 @@ These settings are stored on your laptop, not the server, so you must set them a
178191

179192
---
180193

181-
## PART C: Core Features & Concepts
182-
183-
### 1. Visual Assets Standard
184-
When adding images, you **must** use the correct naming convention so the automation scripts can find them.
185-
186-
| Type | Folder Location | Naming Convention |
187-
| :--- | :--- | :--- |
188-
| **Dashboards** | `docs/assets/images/dashboards/` | `view_[path].png` (e.g. `view_kitchen.png`) |
189-
| **Packages** | `docs/assets/images/packages/` | `[package_name].png` (e.g. `heating.png`) |
190-
| **General** | `docs/assets/images/brand/` | Free choice |
191-
192-
### 2. Locking Files (Prevent Overwrite)
193-
If you have heavily customized a documentation page and don't want the Agent to touch it again:
194-
* Add this to the very top of the Markdown file:
195-
```yaml
196-
---
197-
auto_update: false
198-
---
199-
```
200-
* The Agent is instructed to check for this flag and abort if found.
201-
202-
### 3. Tagging Strategy
203-
We use YAML frontmatter to categorize pages. This enables Tag Clouds on the website.
204-
* **Standard Tags:** `package`, `dashboard`, `network`, `automated`, `manual`.
205-
206-
---
207-
208-
## PART D: Daily Operations (The Workflow)
194+
## PART C: Daily Operations (The Workflow)
209195

210196
### 1. The Full Maintenance Cycle (Recommended Routine)
211-
Run these commands in order to keep everything synced.
197+
Run this sequence to update everything cleanly.
212198

213-
1. **Update Tools:**
214-
```powershell
215-
cd /; python ag_update_docs.py
216-
```
217-
2. **Regenerate Dashboards:**
218-
```powershell
219-
cd /; python ag_regenerate_dashboards.py
220-
```
199+
1. **Update Tools:** `python ag_update_docs.py` (Ensures you have the latest manual and scripts).
200+
2. **Regenerate Dashboards:** `python ag_regenerate_dashboards.py` (Scans HA, redacts names, writes Markdown).
221201
3. **Publish:**
222-
```powershell
202+
```bash
223203
cd docs_site; git add .; git commit -m "Routine update"; git push
224204
```
225205

@@ -235,7 +215,16 @@ Paste this prompt to "hydrate" the AI with the project context:
235215
>
236216
> **Action:** Confirm you have loaded the context and are ready to assist with maintaining the CMDB."
237217

238-
### 3. The Agent Prompts (Execution)
218+
### 3. Visual Assets Standard
219+
When adding images, you **must** use the correct naming convention so the automation scripts can find them.
220+
221+
| Type | Folder Location | Naming Convention |
222+
| :--- | :--- | :--- |
223+
| **Dashboards** | `docs/assets/images/dashboards/` | `view_[path].png` (e.g. `view_kitchen.png`) |
224+
| **Packages** | `docs/assets/images/packages/` | `[package_name].png` (e.g. `heating.png`) |
225+
| **General** | `docs/assets/images/brand/` | Free choice |
226+
227+
### 4. The Agent Prompts (Execution)
239228

240229
**Task: Update Single Package (Focus Mode)**
241230
> "Update the documentation for the **[PACKAGE_NAME]** package.
@@ -259,7 +248,7 @@ Paste this prompt to "hydrate" the AI with the project context:
259248
> 2. **Executive Summary:** What does this package do?
260249
> 3. **Architecture Diagram:** Generate a `mermaid` sequence diagram of the logic.
261250
> 4. **The Code:** Embed the YAML content in a code block (Redact secrets!).
262-
> 5. **Dashboard Connections:** Scan `.storage/lovelace_dashboards` to find associated cards.
251+
> 5. **Dashboard Connections:** Scan `.storage/lovelace_dashboards`. Identify cards that control entities from this package and embed their configuration.
263252
> 6. **Visuals:** Insert a placeholder link for a screenshot (e.g., `![View](assets/images/heating.png)`).
264253
> Finally, update `mkdocs.yml` navigation."
265254

@@ -276,7 +265,7 @@ Paste this prompt to "hydrate" the AI with the project context:
276265
**Task: Convert Dashboard to YAML**
277266
> "Run `python ag_regenerate_dashboards.py`."
278267

279-
### 4. System Integrity Check (Audit)
268+
### 5. System Integrity Check (Audit)
280269
**Use when:** You want to verify the system is healthy.
281270

282271
1. **Run Tool Update:** `python ag_update_docs.py` (Should pass without errors).

0 commit comments

Comments
 (0)