export const documentationTemplate = { id: 'documentation', name: 'Documentation', colorClass: 'bg-amber-500/20', instructions: `## Documentation Step # ⚠️ CRITICAL REQUIREMENT: YOU MUST UPDATE THE CODE WITH DOCUMENTATION ⚠️ **THIS IS NOT OPTIONAL. YOU MUST ADD/UPDATE DOCUMENTATION IN THE CODEBASE.** This step requires you to: 1. **REVIEW** what needs documentation 2. **UPDATE** the code by adding/updating documentation files and code comments **You cannot complete this step by only identifying what needs documentation. You MUST add the documentation directly to the codebase.** --- ### Phase 1: Review Phase Identify what documentation is needed: - Review new functions, classes, and modules - Identify new or modified API endpoints - Check for missing README updates - Identify changelog entries needed --- ### Phase 2: Update Phase - ⚠️ MANDATORY ACTION REQUIRED ⚠️ **YOU MUST NOW ADD/UPDATE DOCUMENTATION IN THE CODEBASE.** **This is not optional. You must modify files to add documentation.** #### Action Steps (You MUST complete these): 1. **Code Documentation** - UPDATE THE CODE FILES: - ✅ Add/update JSDoc or docstrings for new functions and classes - ✅ Document complex algorithms or business logic - ✅ Add inline comments for non-obvious code - ✅ **MODIFY THE SOURCE FILES DIRECTLY WITH DOCUMENTATION** 2. **API Documentation** - UPDATE API DOCUMENTATION FILES: - ✅ Document any new or modified API endpoints - ✅ Include request/response examples - ✅ Document error responses - ✅ **UPDATE THE API DOCUMENTATION FILES DIRECTLY** 3. **README Updates** - UPDATE THE README FILE: - ✅ Update README if new setup steps are required - ✅ Document any new environment variables - ✅ Update architecture diagrams if applicable - ✅ **MODIFY THE README FILE DIRECTLY** 4. **Changelog** - UPDATE THE CHANGELOG FILE: - ✅ Document notable changes for the changelog - ✅ Include breaking changes if any - ✅ **UPDATE THE CHANGELOG FILE DIRECTLY** --- ### Summary Required After completing BOTH review AND update phases, provide: - A summary of documentation needs identified - **A detailed list of ALL documentation files and code comments added/updated (this proves you updated the code)** - Specific files modified with documentation --- # ⚠️ FINAL REMINDER ⚠️ **Identifying documentation needs without adding documentation is INCOMPLETE and UNACCEPTABLE.** **You MUST modify the code files directly to add documentation.** **You MUST show evidence of documentation changes in your summary.** **This step is only complete when documentation has been added to the codebase.**`, };