|
1 | 1 | # Edge React GUI - Agent Guidelines |
2 | 2 |
|
3 | | -> **⚠️ IMPORTANT: Learning and Documentation** |
4 | | -> |
5 | | -> **ALWAYS search for relevant documentation first** before starting any task that lacks sufficient context: |
6 | | -> |
7 | | -> 1. **Use `find docs/ -name "*.md" -type f`** to recursively list all `.md` files in `docs/` folder to get an index of available documentation |
8 | | -> 2. **Read relevant docs** to understand existing conventions, patterns, and business logic |
9 | | -> 3. **Document lessons learned** when prompts contain "always", "remember", "never" or similar instructions |
10 | | -> 4. **Create markdown files** in `docs/` folder for conventions, business logic, and codebase patterns discovered |
11 | | -> 5. **Amend existing docs** rather than creating duplicates to keep knowledge base organized and succinct |
12 | | -> 6. **Prioritize documenting** coding conventions, architectural patterns, and business rules |
13 | | -> 7. **All `.md` files in `docs/` must be indexed** in the Documentation section below with "When to read" and "Summary" descriptions |
| 3 | +## Initialization |
| 4 | + |
| 5 | +**Before starting any task, ensure `docs/` is in context:** |
| 6 | + |
| 7 | +1. **Use `find docs/ -name "*.md" -type f`** to recursively list all `.md` files in `docs/` folder to get an index of available documentation |
| 8 | +2. **Read relevant docs** to understand existing conventions, patterns, and business logic before implementing features |
| 9 | + |
| 10 | +## Workflow |
| 11 | + |
| 12 | +### Documentation Management |
| 13 | + |
| 14 | +- **Document lessons learned** when prompts contain "always", "remember", "never" or similar memory keywords |
| 15 | +- **Create markdown files** in `docs/` folder for conventions, business logic, and codebase patterns discovered |
| 16 | +- **Amend existing docs** rather than creating duplicates to keep knowledge base organized and succinct |
| 17 | +- **Prioritize documenting** coding conventions, architectural patterns, and business rules |
| 18 | +- **All `.md` files in `docs/` must be indexed** in the Documentation section below with "When to read" and "Summary" descriptions |
14 | 19 |
|
15 | 20 | ## Package Manager |
16 | 21 |
|
|
0 commit comments