Skip to content

Commit c5337df

Browse files
committed
Update Navi
1 parent c6f69d6 commit c5337df

1 file changed

Lines changed: 41 additions & 43 deletions

File tree

docs/system_manual/setup_guide.md

Lines changed: 41 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
<!-- VALIDATION_CHECKLIST: ["## PART A", "## PART B", "## PART C", "Visual Assets Standard", "Task: Standardize Package Headers", "Task: Update Structure Documentation"] -->
1+
<!-- VALIDATION_CHECKLIST: ["## PART A", "## PART B", "## PART C", "## PART D", "## PART E", "## PART F", "Visual Assets Standard", "Task: Standardize Package Headers"] -->
22
# EvisHomeLab: Documentation System Manual
33

4-
**Version:** 7.3 (Added Local Commit Workflow)
4+
**Version:** 8.1 (Modularized)
55
**Philosophy:** Agentic CMDB (Configuration Management Database)
66
**Strategy:** "Detached Docs" (Private Config -> Public Documentation)
77

@@ -48,69 +48,70 @@ Create `.antigravity/rules.md`:
4848
* **Trust Git:** Terminal > `git config --global --add safe.directory '*'`.
4949

5050
---
51-
## PART C: Daily Operations (The Workflow)
51+
## PART C: Core Concepts & Standards
5252

53-
### 1. The Full Maintenance Cycle
53+
### 1. Visual Assets Standard
54+
Images must be sorted into subfolders to keep the repo clean.
55+
* **Dashboards:** `docs/assets/images/dashboards/view_[path].png`
56+
* **Packages:** `docs/assets/images/packages/[name].png`
57+
* **Brand:** `docs/assets/images/brand/`
58+
59+
### 2. Locking Files (Prevent Overwrite)
60+
To protect a manually written page from the Agent:
61+
* Add `auto_update: false` to the YAML frontmatter at the top of the Markdown file.
62+
63+
### 3. Tagging Strategy
64+
Use YAML frontmatter to categorize pages for the Tag Cloud.
65+
* **Standard Tags:** `package`, `dashboard`, `network`, `automated`, `manual`.
66+
67+
---
68+
69+
## PART D: Daily Operations (The Workflow)
70+
71+
### 1. The Full Maintenance Cycle (Recommended)
5472
Run these commands in order to keep everything synced.
5573

56-
1. **Mass Commit Config (Local):** Saves all Home Assistant changes to your local history.
57-
```powershell
58-
git add .; git commit -m "Work in progress: Config updates"
59-
```
60-
2. **Update Tools:** `python ag_update_docs.py` (Refreshes manual/scripts).
74+
1. **Commit Config (Local Repo A):**
75+
* `git add .; git commit -m "WIP: Config updates"`
76+
2. **Update Tools:**
77+
* `python ag_update_docs.py` (Refreshes manual/scripts).
6178
3. **Regenerate Docs:**
6279
* Dashboards: `python ag_regenerate_dashboards.py`
6380
* Packages: `python ag_update_package.py --all`
64-
4. **Publish Docs (Public):**
65-
```powershell
66-
cd docs_site; git add .; git commit -m "Routine update"; git push
67-
```
81+
4. **Publish Docs (Public Repo B):**
82+
* `cd docs_site; git add .; git commit -m "Routine update"; git push`
6883

6984
### 2. The AI Architect Workflow
7085
**Start new chats with:** "I am resuming EvisHomeLab. Read `docs_site/AI_CONTEXT.md` and `docs_site/docs/system_manual/setup_guide.md`. Adopt the persona."
7186

72-
### 3. Visual Assets Standard
73-
* **Dashboards:** `docs/assets/images/dashboards/view_[path].png`
74-
* **Packages:** `docs/assets/images/packages/[name].png`
75-
* **Brand:** `docs/assets/images/brand/`
76-
77-
### 4. The Agent Prompts
87+
### 3. The Agent Prompts
7888

79-
**Task: Standardize Package Headers (Source Code Management)**
80-
> "Scan the `packages/` directory. For every YAML file:
81-
> 1. **Analyze:** Read the file to determine its dependencies (entities used) and purpose.
82-
> 2. **Check Header:** Look for an existing top comment block.
83-
> 3. **Action:**
84-
> - **If missing:** Prepend the standard header.
85-
> - **If present but legacy/incomplete:** REPLACE the existing top comments with the standard header format (ensure `Version` is present).
86-
> - **Standard Header Format:**
89+
**Task: Standardize Package Headers**
90+
> "Scan `packages/`. Check headers. If missing/legacy, prepend:
8791
> ```yaml
8892
> # ------------------------------------------------------------------------------
8993
> # Package: [Filename]
9094
> # Version: 1.0.0
91-
> # Description: [Agent-generated summary]
92-
> # Dependencies: [List of major entities/integrations detected]
95+
> # Description: [Summary]
96+
> # Dependencies: [Entities used]
9397
> # ------------------------------------------------------------------------------
9498
> ```"
9599
96-
**Task: Update Package Documentation (Focus Mode)**
100+
**Task: Update Single Package (Focus Mode)**
97101
> "Run `python ag_update_package.py [package_name]`."
98-
> *(Fallback: "Update `[package].md` reading from `[package].yaml`. Check frontmatter `auto_update`.")*
102+
> *(Fallback: "Update `[package].md` reading from `[package].yaml`. Check `auto_update` lock.")*
99103
100-
**Task: Update Structure Documentation**
101-
> "Update `docs_site/docs/smart-home/structure.md`.
102-
> 1. Re-scan the root directory and update the file tree structure description (Folders first, then files).
103-
> 2. Read `configuration.yaml` and update the commented code block explanation."
104+
**Task: Update Architecture (Structure & Overview)**
105+
> "Update `docs_site/docs/smart-home/structure.md` AND `docs_site/docs/index.md`.
106+
> 1. **Structure:** Re-scan root. Update file tree.
107+
> 2. **Overview:** Update 'High Level Architecture' with new integrations."
104108
105109
**Task: Web Design & Image Management**
106110
> "Scan `assets/images/`. Update Markdown files to replace placeholder text with actual image links. If asking for CSS changes, edit `assets/css/custom.css`."
107111
108-
**Task: Generate All Package Documentation (Manual Fallback)**
112+
**Task: Generate All Package Documentation**
109113
> "Deep scan `packages/`. Create Markdown for all files with: Frontmatter tags, Summary, Architecture Diagram, Redacted Code, Dashboard connections, and Visuals."
110114
111-
**Task: Enable Tags & Tag Cloud**
112-
> "Edit `docs_site/mkdocs.yml`. Add `- tags` under `plugins:`."
113-
114115
---
115116
## PART E: Tool Reference
116117
@@ -121,10 +122,7 @@ The Master Orchestrator. Imports content from `.ag_definitions/`, validates it,
121122
The Privacy Engine. Reads `.storage/lovelace_dashboards`, performs regex-based name redaction (Jukka->Evis), and outputs clean YAML blocks.
122123
123124
### 3. `ag_update_package.py`
124-
The Package Doc Generator.
125-
* **Single Mode:** `python ag_update_package.py heating` (Updates one file).
126-
* **Batch Mode:** `python ag_update_package.py --all` (Updates all packages).
127-
* **Features:** Extracts header metadata (Version/Desc), checks for `auto_update: false` locks, and redacts secrets.
125+
The Package Doc Generator. Reads a specific package YAML, extracts header metadata (Version/Desc), and updates the specific Markdown file.
128126
129127
---
130128
## PART F: Troubleshooting

0 commit comments

Comments
 (0)