From 386eeb423dbf5362d993b0758494bb4a6cae7d54 Mon Sep 17 00:00:00 2001
From: Grace <grace@ubuntu-server-ai>
Date: Tue, 17 Mar 2026 16:20:57 -0700
Subject: [PATCH] Add stack overview doc template

---
 docs/templates/stack-overview-template.md | 72 +++++++++++++++++++++++
 1 file changed, 72 insertions(+)
 create mode 100644 docs/templates/stack-overview-template.md

diff --git a/docs/templates/stack-overview-template.md b/docs/templates/stack-overview-template.md
new file mode 100644
index 0000000..68f1da6
--- /dev/null
+++ b/docs/templates/stack-overview-template.md
@@ -0,0 +1,72 @@
+# {{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. -->
+
+<!-- AI GENERATED START: Change Log -->
+{{change_log}}
+<!-- AI GENERATED END -->
+
+---
+
+## References
+- [Official Documentation]({{docs_url}})
+- [Related Stack or Module]({{related_url}})