85 lines
2.9 KiB
Markdown
85 lines
2.9 KiB
Markdown
# {{stack_name}} Stack Documentation
|
|
<!--
|
|
AI USAGE INSTRUCTIONS:
|
|
- The AI agent is responsible for writing the full documentation.
|
|
- Preserve all formatting (headings, bullet points, code blocks).
|
|
- Always append new items instead of deleting content unless explicitly authorized.
|
|
- Ensure clarity on how this stack interacts with other stacks or modules.
|
|
-->
|
|
|
|
---
|
|
|
|
## Overview
|
|
<!-- AI INSTRUCTION: Describe the stack as a whole, its purpose, and high-level functionality. -->
|
|
|
|
{{overview_description}}
|
|
|
|
---
|
|
|
|
## Installation
|
|
<!-- AI INSTRUCTION: Provide installation/setup steps for the stack components, including OS-level, containerized, or orchestration instructions. Include version notes and dependencies. -->
|
|
|
|
{{installation_steps}}
|
|
|
|
---
|
|
|
|
## Configuration
|
|
<!-- AI INSTRUCTION: Document all configuration parameters for the stack. Include defaults, examples, optional vs required parameters, environment variables, and external secrets (e.g., stored in Infisical). -->
|
|
|
|
{{configuration_details}}
|
|
|
|
---
|
|
|
|
## Connections to Other Services, Systems, and Modules
|
|
<!-- AI INSTRUCTION: List all external and internal connections, describe how this stack interacts with other stacks or modules. Include databases, message queues, APIs, storage, monitoring systems, etc. -->
|
|
|
|
{{connections_list_and_description}}
|
|
|
|
---
|
|
|
|
## Usage Examples
|
|
<!-- AI INSTRUCTION: Provide practical usage scenarios for developers or operators. Include API calls, CLI commands, or code snippets. Append examples if updating. -->
|
|
|
|
{{usage_examples}}
|
|
|
|
---
|
|
|
|
## Dependencies
|
|
<!-- AI INSTRUCTION: List all libraries, modules, and services required for the stack. Include versions and whether credentials are required. -->
|
|
|
|
{{dependencies_list}}
|
|
|
|
---
|
|
|
|
## Troubleshooting
|
|
<!-- AI INSTRUCTION: Add common issues and solutions for installation, configuration, and operation of the stack. Include date stamps for new tips. -->
|
|
|
|
{{troubleshooting_tips}}
|
|
|
|
---
|
|
|
|
## Change Log
|
|
<!-- 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 -->
|
|
{{change_log}}
|
|
<!-- AI GENERATED END -->
|
|
|
|
---
|
|
|
|
## References
|
|
<!-- AI INSTRUCTION: Include official docs, repos, guides, or RAG import TODOs. Indicate if online documentation has not yet been imported into the RAG. -->
|
|
|
|
{{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.
|
|
-->
|