Skip to content

Commit 1ff54de

Browse files
committed
Update Dishwasher
1 parent ca1e51a commit 1ff54de

1 file changed

Lines changed: 26 additions & 12 deletions

File tree

docs/system_manual/setup_guide.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -86,22 +86,36 @@ Run these commands in order to keep everything synced.
8686

8787
### 3. The Agent Prompts
8888

89-
**Task: Standardize Package Headers**
89+
**Task: Standardize Package Headers (Source Code Management)**
9090
> "Scan `packages/`. Check headers. If missing/legacy, prepend:
91-
>
92-
> ```yaml
93-
> # ------------------------------------------------------------------------------
94-
> # Package: [Filename]
95-
> # Version: 1.0.0
96-
> # Description: [Summary]
97-
> # Dependencies: [Entities used]
98-
> # ------------------------------------------------------------------------------
99-
> ```"
100-
101-
**Task: Update Single Package (Focus Mode)**
91+
92+
```yaml
93+
# ------------------------------------------------------------------------------
94+
# Package: [Filename]
95+
# Version: 1.0.0
96+
# Description: [Summary]
97+
# Dependencies: [Entities used]
98+
# ------------------------------------------------------------------------------
99+
```"
100+
101+
**Task: Deep Package Analysis (Mermaid & Summary)**
102+
*Use this prompt to add diagrams and intelligence to an existing package document.*
103+
> "Update the documentation for the **[PACKAGE_NAME]** package.
104+
> 1. Read `packages/[PACKAGE_NAME].yaml` and `docs_site/docs/smart-home/packages/[PACKAGE_NAME].md`.
105+
> 2. **Guard Check:** If the Markdown contains `auto_update: false`, **ABORT**.
106+
> 3. **Smart Analysis:**
107+
> - **Summary:** Provide a detailed executive summary of the package's functionality.
108+
> - **Architecture:** Generate a `mermaid` sequence diagram illustrating the primary logic flow (e.g., `Trigger -> Condition -> Action`).
109+
> 4. **Update Documentation File:**
110+
> - **Do NOT** overwrite the entire file.
111+
> - **Find & Replace:** Insert the generated Summary and Diagram into the relevant sections/placeholders in the existing Markdown content."
112+
113+
**Task: Update Package Documentation (Boilerplate & Version Stamp)**
114+
*Use this prompt to quickly update versioning, tags, and code block content.*
102115
> "Run `python ag_update_package.py [package_name]`."
103116
> *(Fallback: "Update `[package].md` reading from `[package].yaml`. Check `auto_update` lock.")*
104117

118+
105119
**Task: Update Architecture (Structure & Overview)**
106120
> "Update `docs_site/docs/smart-home/structure.md` AND `docs_site/docs/index.md`.
107121
>

0 commit comments

Comments
 (0)