Grace/homelab-ai-agent
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

Update stack overview template: add References section and agent notes

Browse Source
This commit is contained in:
Grace
2026-03-17 16:21:47 -07:00
parent 386eeb423d
commit e7a02e570c
1 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/templates/stack-overview-template.md vendored
View File

@@ -59,7 +59,7 @@ AI USAGE INSTRUCTIONS:
--- ---
## Change Log ## Change Log
<!-- AI INSTRUCTION: Keep a running log of updates, additions, or fixes to the stack. Include date, type, and summary. Append only. --> <!-- AI INSTRUCTION: Keep a running log of updates, additions, or fixes to the stack. Include date, type, and summary. Append only. Format: YYYY-MM-DD | Added/Updated/Fixed | Summary -->
<!-- AI GENERATED START: Change Log --> <!-- AI GENERATED START: Change Log -->
{{change_log}} {{change_log}}
@@ -68,5 +68,17 @@ AI USAGE INSTRUCTIONS:
--- ---
## References ## References
- [Official Documentation]({{docs_url}}) <!-- AI INSTRUCTION: Include official docs, repos, guides, or RAG import TODOs. Indicate if online documentation has not yet been imported into the RAG. -->
- [Related Stack or Module]({{related_url}})
{{references}}
---
<!--
### Notes for the AI Agent
1. Each section has specific instructions and examples so the AI can generate content consistently.
2. Connections section emphasizes the stack-level view — where this stack sits in the system architecture and what it communicates with.
3. References section includes TODOs for RAG imports to ensure offline or indexed documentation.
4. This template can be reused for multiple stacks (AI, NextCloud, Dashboard/Monitoring, GIS Editing, etc.) by replacing {{stack_name}} and filling in the placeholders.
-->