-
Notifications
You must be signed in to change notification settings - Fork 46
Closed as not planned
Closed as not planned
Copy link
Labels
ai-generatedcookieIssue Monster Loves Cookies!Issue Monster Loves Cookies!documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestperformanceplan
Description
Objective
Develop reusable documentation templates (INDEX, README, QUICKREF, EXAMPLE, CONFIG) that reduce token consumption while maintaining quality and consistency.
Context
Research from #12193 shows the agent creates similar documentation structures across workflows (~60-70 KB per package with 5-7 files). The consistent patterns (INDEX navigation, README setup, QUICKREF cheat sheets, etc.) suggest opportunities for template reuse to optimize token usage without sacrificing quality.
Approach
- Extract common documentation structures into templates:
INDEX.mdtemplate with navigation structureREADME.mdtemplate with setup sectionsQUICKREF.mdtemplate with command reference formatEXAMPLE.mdtemplate with sample output structureCONFIG-TEMPLATE.mdtemplate with deployment checklist
- Store templates in
pkg/workflow/templates/or similar location - Update agent instructions to reference templates and fill in workflow-specific details
- Measure token reduction vs comprehensive generation
Files to Create
pkg/workflow/templates/INDEX.template.mdpkg/workflow/templates/README.template.mdpkg/workflow/templates/QUICKREF.template.mdpkg/workflow/templates/EXAMPLE.template.mdpkg/workflow/templates/CONFIG.template.md
Files to Modify
.github/instructions/*.instructions.md- Reference templates in agent instructionspkg/workflow/compiler.go- Template loading and interpolation logicAGENTS.md- Document template usage guidelines
Acceptance Criteria
- Templates created for all 5 common documentation files
- Templates include placeholder syntax for workflow-specific content
- Agent instructions reference templates appropriately
- Generated documentation maintains quality standards
- Token usage reduced (measure before/after)
- Tests validate template interpolation
Reference
See discussion #12193 "Recommendations" section: "Template Reuse"
AI generated by Plan Command for discussion #12193
Reactions are currently unavailable
Metadata
Metadata
Labels
ai-generatedcookieIssue Monster Loves Cookies!Issue Monster Loves Cookies!documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestperformanceplan