109 lines
2.6 KiB
Markdown
109 lines
2.6 KiB
Markdown
# {{module_name}} Documentation
|
|
<!--
|
|
AI USAGE INSTRUCTIONS:
|
|
- Preserve all formatting (headings, bullet points, code blocks).
|
|
- Always append new items instead of deleting existing content unless a removal is explicitly authorized.
|
|
-->
|
|
|
|
---
|
|
|
|
## Overview
|
|
{{module_name}} is a module/service that provides the following functionality:
|
|
|
|
- Purpose: {{brief purpose description}}
|
|
- Primary Use Cases: {{key scenarios}}
|
|
|
|
---
|
|
|
|
## Installation
|
|
<!-- AI GENERATED START: Installation -->
|
|
{{installation_steps}}
|
|
<!-- AI GENERATED END -->
|
|
|
|
AI PROMPT GUIDELINE:
|
|
- Only modify the installation instructions here.
|
|
- Include version-specific steps if relevant.
|
|
- Add notes about dependencies.
|
|
- Keep commands formatted in code blocks.
|
|
|
|
---
|
|
|
|
## Configuration
|
|
<!-- AI GENERATED START: Configuration -->
|
|
{{configuration_details}}
|
|
<!-- AI GENERATED END -->
|
|
|
|
AI PROMPT GUIDELINE:
|
|
- Only update configuration options.
|
|
- Include default values and examples.
|
|
- Do not remove existing valid options.
|
|
- Highlight optional vs required parameters.
|
|
|
|
---
|
|
|
|
## Connections to other services, systems, and modules
|
|
<!-- AI GENERATED START: Dependencies -->
|
|
{{connections_list_and_description}}
|
|
<!-- AI GENERATED END -->
|
|
|
|
AI PROMPT GUIDELINE:
|
|
- List all connection that are made to other services, systems, and modules. Where does this module sit in the stack?
|
|
|
|
---
|
|
|
|
## Usage Examples
|
|
<!-- AI GENERATED START: Usage Examples -->
|
|
{{usage_examples}}
|
|
<!-- AI GENERATED END -->
|
|
|
|
AI PROMPT GUIDELINE:
|
|
- Add practical examples, commands, or API snippets.
|
|
- Format code blocks correctly.
|
|
- If updating, append new examples; never rewrite old ones unless flagged.
|
|
|
|
---
|
|
|
|
## Dependencies
|
|
<!-- AI GENERATED START: Dependencies -->
|
|
{{dependencies_list}}
|
|
<!-- AI GENERATED END -->
|
|
|
|
AI PROMPT GUIDELINE:
|
|
- List all libraries, modules, or services required.
|
|
- Include version constraints if applicable.
|
|
- Append new dependencies rather than replacing the list.
|
|
- Have credentials been added to Infisical?
|
|
- Is there a Web UI that needs to be configured?
|
|
|
|
---
|
|
|
|
## Troubleshooting
|
|
<!-- AI GENERATED START: Troubleshooting -->
|
|
{{troubleshooting_tips}}
|
|
<!-- AI GENERATED END -->
|
|
|
|
AI PROMPT GUIDELINE:
|
|
- Add solutions to common issues encountered during installation, configuration, or usage.
|
|
- Preserve existing tips.
|
|
- Add new tips with date stamps.
|
|
|
|
---
|
|
|
|
## Change Log
|
|
<!-- AI GENERATED START: Change Log -->
|
|
{{change_log}}
|
|
<!-- AI GENERATED END -->
|
|
|
|
AI PROMPT GUIDELINE:
|
|
- Always append a new entry with:
|
|
- Date (YYYY-MM-DD)
|
|
- Type (Added / Updated / Fixed)
|
|
- Summary of changes
|
|
- Do not remove previous entries.
|
|
|
|
---
|
|
|
|
## References
|
|
- [Official Module Repo]({{repo_url}})
|
|
- [Related Documentation]({{related_docs_url}})
|