@ai-coders/context 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (228) hide show
  1. package/README.md +32 -25
  2. package/dist/commands/shared/agents.d.ts +2 -0
  3. package/dist/commands/shared/agents.d.ts.map +1 -0
  4. package/dist/commands/shared/agents.js +15 -0
  5. package/dist/commands/shared/agents.js.map +1 -0
  6. package/dist/commands/shared/selection.d.ts +12 -0
  7. package/dist/commands/shared/selection.d.ts.map +1 -0
  8. package/dist/commands/shared/selection.js +95 -0
  9. package/dist/commands/shared/selection.js.map +1 -0
  10. package/dist/generators/agents/agentConfig.d.ts.map +1 -1
  11. package/dist/generators/agents/agentConfig.js +42 -0
  12. package/dist/generators/agents/agentConfig.js.map +1 -1
  13. package/dist/generators/agents/agentGenerator.d.ts +0 -1
  14. package/dist/generators/agents/agentGenerator.d.ts.map +1 -1
  15. package/dist/generators/agents/agentGenerator.js +7 -47
  16. package/dist/generators/agents/agentGenerator.js.map +1 -1
  17. package/dist/generators/agents/agentTypes.d.ts +1 -1
  18. package/dist/generators/agents/agentTypes.d.ts.map +1 -1
  19. package/dist/generators/agents/agentTypes.js +4 -1
  20. package/dist/generators/agents/agentTypes.js.map +1 -1
  21. package/dist/generators/agents/templates/indexTemplate.d.ts.map +1 -1
  22. package/dist/generators/agents/templates/indexTemplate.js +2 -1
  23. package/dist/generators/agents/templates/indexTemplate.js.map +1 -1
  24. package/dist/generators/agents/templates/playbookTemplate.d.ts.map +1 -1
  25. package/dist/generators/agents/templates/playbookTemplate.js +39 -3
  26. package/dist/generators/agents/templates/playbookTemplate.js.map +1 -1
  27. package/dist/generators/documentation/documentationGenerator.d.ts +3 -1
  28. package/dist/generators/documentation/documentationGenerator.d.ts.map +1 -1
  29. package/dist/generators/documentation/documentationGenerator.js +88 -15
  30. package/dist/generators/documentation/documentationGenerator.js.map +1 -1
  31. package/dist/generators/documentation/guideRegistry.js +8 -8
  32. package/dist/generators/documentation/guideRegistry.js.map +1 -1
  33. package/dist/generators/documentation/templates/apiReferenceTemplate.d.ts +2 -0
  34. package/dist/generators/documentation/templates/apiReferenceTemplate.d.ts.map +1 -0
  35. package/dist/generators/documentation/templates/apiReferenceTemplate.js +490 -0
  36. package/dist/generators/documentation/templates/apiReferenceTemplate.js.map +1 -0
  37. package/dist/generators/documentation/templates/architectureTemplate.d.ts.map +1 -1
  38. package/dist/generators/documentation/templates/architectureTemplate.js +27 -27
  39. package/dist/generators/documentation/templates/architectureTemplate.js.map +1 -1
  40. package/dist/generators/documentation/templates/common.js +2 -2
  41. package/dist/generators/documentation/templates/common.js.map +1 -1
  42. package/dist/generators/documentation/templates/dataFlowTemplate.d.ts.map +1 -1
  43. package/dist/generators/documentation/templates/dataFlowTemplate.js +5 -20
  44. package/dist/generators/documentation/templates/dataFlowTemplate.js.map +1 -1
  45. package/dist/generators/documentation/templates/developmentWorkflowTemplate.d.ts.map +1 -1
  46. package/dist/generators/documentation/templates/developmentWorkflowTemplate.js +5 -20
  47. package/dist/generators/documentation/templates/developmentWorkflowTemplate.js.map +1 -1
  48. package/dist/generators/documentation/templates/glossaryTemplate.d.ts.map +1 -1
  49. package/dist/generators/documentation/templates/glossaryTemplate.js +9 -23
  50. package/dist/generators/documentation/templates/glossaryTemplate.js.map +1 -1
  51. package/dist/generators/documentation/templates/index.d.ts +4 -0
  52. package/dist/generators/documentation/templates/index.d.ts.map +1 -1
  53. package/dist/generators/documentation/templates/index.js +9 -1
  54. package/dist/generators/documentation/templates/index.js.map +1 -1
  55. package/dist/generators/documentation/templates/indexTemplate.d.ts.map +1 -1
  56. package/dist/generators/documentation/templates/indexTemplate.js +5 -19
  57. package/dist/generators/documentation/templates/indexTemplate.js.map +1 -1
  58. package/dist/generators/documentation/templates/migrationTemplate.d.ts +2 -0
  59. package/dist/generators/documentation/templates/migrationTemplate.d.ts.map +1 -0
  60. package/dist/generators/documentation/templates/migrationTemplate.js +422 -0
  61. package/dist/generators/documentation/templates/migrationTemplate.js.map +1 -0
  62. package/dist/generators/documentation/templates/onboardingTemplate.d.ts +2 -0
  63. package/dist/generators/documentation/templates/onboardingTemplate.d.ts.map +1 -0
  64. package/dist/generators/documentation/templates/onboardingTemplate.js +431 -0
  65. package/dist/generators/documentation/templates/onboardingTemplate.js.map +1 -0
  66. package/dist/generators/documentation/templates/projectOverviewTemplate.d.ts.map +1 -1
  67. package/dist/generators/documentation/templates/projectOverviewTemplate.js +22 -25
  68. package/dist/generators/documentation/templates/projectOverviewTemplate.js.map +1 -1
  69. package/dist/generators/documentation/templates/securityTemplate.d.ts.map +1 -1
  70. package/dist/generators/documentation/templates/securityTemplate.js +5 -19
  71. package/dist/generators/documentation/templates/securityTemplate.js.map +1 -1
  72. package/dist/generators/documentation/templates/testingTemplate.d.ts.map +1 -1
  73. package/dist/generators/documentation/templates/testingTemplate.js +5 -19
  74. package/dist/generators/documentation/templates/testingTemplate.js.map +1 -1
  75. package/dist/generators/documentation/templates/toolingTemplate.d.ts.map +1 -1
  76. package/dist/generators/documentation/templates/toolingTemplate.js +6 -20
  77. package/dist/generators/documentation/templates/toolingTemplate.js.map +1 -1
  78. package/dist/generators/documentation/templates/troubleshootingTemplate.d.ts +2 -0
  79. package/dist/generators/documentation/templates/troubleshootingTemplate.d.ts.map +1 -0
  80. package/dist/generators/documentation/templates/troubleshootingTemplate.js +292 -0
  81. package/dist/generators/documentation/templates/troubleshootingTemplate.js.map +1 -0
  82. package/dist/generators/plans/templates/indexTemplate.d.ts.map +1 -1
  83. package/dist/generators/plans/templates/indexTemplate.js +3 -2
  84. package/dist/generators/plans/templates/indexTemplate.js.map +1 -1
  85. package/dist/generators/plans/templates/planTemplate.d.ts.map +1 -1
  86. package/dist/generators/plans/templates/planTemplate.js +96 -13
  87. package/dist/generators/plans/templates/planTemplate.js.map +1 -1
  88. package/dist/generators/shared/generatorUtils.d.ts +1 -1
  89. package/dist/generators/shared/generatorUtils.d.ts.map +1 -1
  90. package/dist/generators/shared/generatorUtils.js +1 -1
  91. package/dist/generators/shared/generatorUtils.js.map +1 -1
  92. package/dist/index.d.ts +2 -2
  93. package/dist/index.d.ts.map +1 -1
  94. package/dist/index.js +111 -1007
  95. package/dist/index.js.map +1 -1
  96. package/dist/prompts/defaults.d.ts +3 -0
  97. package/dist/prompts/defaults.d.ts.map +1 -0
  98. package/dist/prompts/defaults.js +95 -0
  99. package/dist/prompts/defaults.js.map +1 -0
  100. package/dist/services/baseLLMClient.d.ts +3 -3
  101. package/dist/services/baseLLMClient.d.ts.map +1 -1
  102. package/dist/services/baseLLMClient.js +44 -5
  103. package/dist/services/baseLLMClient.js.map +1 -1
  104. package/dist/services/fill/fillService.d.ts +46 -0
  105. package/dist/services/fill/fillService.d.ts.map +1 -0
  106. package/dist/services/fill/fillService.js +254 -0
  107. package/dist/services/fill/fillService.js.map +1 -0
  108. package/dist/services/init/initService.d.ts +37 -0
  109. package/dist/services/init/initService.d.ts.map +1 -0
  110. package/dist/services/init/initService.js +167 -0
  111. package/dist/services/init/initService.js.map +1 -0
  112. package/dist/services/llmClientFactory.d.ts +2 -8
  113. package/dist/services/llmClientFactory.d.ts.map +1 -1
  114. package/dist/services/llmClientFactory.js +10 -96
  115. package/dist/services/llmClientFactory.js.map +1 -1
  116. package/dist/services/openRouterClient.d.ts +0 -3
  117. package/dist/services/openRouterClient.d.ts.map +1 -1
  118. package/dist/services/openRouterClient.js +2 -49
  119. package/dist/services/openRouterClient.js.map +1 -1
  120. package/dist/services/plan/planService.d.ts +57 -0
  121. package/dist/services/plan/planService.d.ts.map +1 -0
  122. package/dist/services/plan/planService.js +334 -0
  123. package/dist/services/plan/planService.js.map +1 -0
  124. package/dist/services/shared/llmConfig.d.ts +22 -0
  125. package/dist/services/shared/llmConfig.d.ts.map +1 -0
  126. package/dist/services/shared/llmConfig.js +38 -0
  127. package/dist/services/shared/llmConfig.js.map +1 -0
  128. package/dist/types.d.ts +7 -2
  129. package/dist/types.d.ts.map +1 -1
  130. package/dist/utils/fileMapper.d.ts +1 -1
  131. package/dist/utils/fileMapper.d.ts.map +1 -1
  132. package/dist/utils/fileMapper.js +40 -19
  133. package/dist/utils/fileMapper.js.map +1 -1
  134. package/dist/utils/i18n.d.ts +23 -33
  135. package/dist/utils/i18n.d.ts.map +1 -1
  136. package/dist/utils/i18n.js +48 -68
  137. package/dist/utils/i18n.js.map +1 -1
  138. package/dist/utils/promptLoader.d.ts +12 -0
  139. package/dist/utils/promptLoader.d.ts.map +1 -0
  140. package/dist/utils/promptLoader.js +81 -0
  141. package/dist/utils/promptLoader.js.map +1 -0
  142. package/dist/utils/versionChecker.d.ts +15 -0
  143. package/dist/utils/versionChecker.d.ts.map +1 -0
  144. package/dist/utils/versionChecker.js +49 -0
  145. package/dist/utils/versionChecker.js.map +1 -0
  146. package/package.json +9 -10
  147. package/prompts/update_plan_prompt.md +4 -5
  148. package/prompts/update_scaffold_prompt.md +7 -8
  149. package/dist/generators/agents/contextUtils.d.ts +0 -8
  150. package/dist/generators/agents/contextUtils.d.ts.map +0 -1
  151. package/dist/generators/agents/contextUtils.js +0 -15
  152. package/dist/generators/agents/contextUtils.js.map +0 -1
  153. package/dist/generators/agents/promptFormatter.d.ts +0 -9
  154. package/dist/generators/agents/promptFormatter.d.ts.map +0 -1
  155. package/dist/generators/agents/promptFormatter.js +0 -84
  156. package/dist/generators/agents/promptFormatter.js.map +0 -1
  157. package/dist/generators/analyzers/codebaseAnalyzer.d.ts +0 -45
  158. package/dist/generators/analyzers/codebaseAnalyzer.d.ts.map +0 -1
  159. package/dist/generators/analyzers/codebaseAnalyzer.js +0 -293
  160. package/dist/generators/analyzers/codebaseAnalyzer.js.map +0 -1
  161. package/dist/generators/analyzers/index.d.ts +0 -3
  162. package/dist/generators/analyzers/index.d.ts.map +0 -1
  163. package/dist/generators/analyzers/index.js +0 -6
  164. package/dist/generators/analyzers/index.js.map +0 -1
  165. package/dist/generators/documentation/documentationTemplates.d.ts +0 -21
  166. package/dist/generators/documentation/documentationTemplates.d.ts.map +0 -1
  167. package/dist/generators/documentation/documentationTemplates.js +0 -359
  168. package/dist/generators/documentation/documentationTemplates.js.map +0 -1
  169. package/dist/generators/documentation/documentationTypes.d.ts +0 -11
  170. package/dist/generators/documentation/documentationTypes.d.ts.map +0 -1
  171. package/dist/generators/documentation/documentationTypes.js +0 -22
  172. package/dist/generators/documentation/documentationTypes.js.map +0 -1
  173. package/dist/generators/documentation/documentationUtils.d.ts +0 -7
  174. package/dist/generators/documentation/documentationUtils.d.ts.map +0 -1
  175. package/dist/generators/documentation/documentationUtils.js +0 -28
  176. package/dist/generators/documentation/documentationUtils.js.map +0 -1
  177. package/dist/generators/documentation/incrementalDocumentationGenerator.d.ts +0 -33
  178. package/dist/generators/documentation/incrementalDocumentationGenerator.d.ts.map +0 -1
  179. package/dist/generators/documentation/incrementalDocumentationGenerator.js +0 -400
  180. package/dist/generators/documentation/incrementalDocumentationGenerator.js.map +0 -1
  181. package/dist/generators/documentation/templates.d.ts +0 -31
  182. package/dist/generators/documentation/templates.d.ts.map +0 -1
  183. package/dist/generators/documentation/templates.js +0 -566
  184. package/dist/generators/documentation/templates.js.map +0 -1
  185. package/dist/generators/guidelines/agentIntegration.d.ts +0 -43
  186. package/dist/generators/guidelines/agentIntegration.d.ts.map +0 -1
  187. package/dist/generators/guidelines/agentIntegration.js +0 -157
  188. package/dist/generators/guidelines/agentIntegration.js.map +0 -1
  189. package/dist/generators/guidelines/guidelineTypes.d.ts +0 -40
  190. package/dist/generators/guidelines/guidelineTypes.d.ts.map +0 -1
  191. package/dist/generators/guidelines/guidelineTypes.js +0 -144
  192. package/dist/generators/guidelines/guidelineTypes.js.map +0 -1
  193. package/dist/generators/guidelines/guidelinesAnalyzer.d.ts +0 -30
  194. package/dist/generators/guidelines/guidelinesAnalyzer.d.ts.map +0 -1
  195. package/dist/generators/guidelines/guidelinesAnalyzer.js +0 -263
  196. package/dist/generators/guidelines/guidelinesAnalyzer.js.map +0 -1
  197. package/dist/generators/guidelines/guidelinesGenerator.d.ts +0 -30
  198. package/dist/generators/guidelines/guidelinesGenerator.d.ts.map +0 -1
  199. package/dist/generators/guidelines/guidelinesGenerator.js +0 -249
  200. package/dist/generators/guidelines/guidelinesGenerator.js.map +0 -1
  201. package/dist/generators/guidelines/guidelinesTemplates.d.ts +0 -23
  202. package/dist/generators/guidelines/guidelinesTemplates.d.ts.map +0 -1
  203. package/dist/generators/guidelines/guidelinesTemplates.js +0 -304
  204. package/dist/generators/guidelines/guidelinesTemplates.js.map +0 -1
  205. package/dist/generators/guidelines/index.d.ts +0 -6
  206. package/dist/generators/guidelines/index.d.ts.map +0 -1
  207. package/dist/generators/guidelines/index.js +0 -16
  208. package/dist/generators/guidelines/index.js.map +0 -1
  209. package/dist/generators/moduleGrouper.d.ts +0 -14
  210. package/dist/generators/moduleGrouper.d.ts.map +0 -1
  211. package/dist/generators/moduleGrouper.js +0 -82
  212. package/dist/generators/moduleGrouper.js.map +0 -1
  213. package/dist/generators/projectAnalyzer.d.ts +0 -14
  214. package/dist/generators/projectAnalyzer.d.ts.map +0 -1
  215. package/dist/generators/projectAnalyzer.js +0 -217
  216. package/dist/generators/projectAnalyzer.js.map +0 -1
  217. package/dist/services/changeAnalyzer.d.ts +0 -44
  218. package/dist/services/changeAnalyzer.d.ts.map +0 -1
  219. package/dist/services/changeAnalyzer.js +0 -344
  220. package/dist/services/changeAnalyzer.js.map +0 -1
  221. package/dist/utils/interactiveMode.d.ts +0 -21
  222. package/dist/utils/interactiveMode.d.ts.map +0 -1
  223. package/dist/utils/interactiveMode.js +0 -737
  224. package/dist/utils/interactiveMode.js.map +0 -1
  225. package/dist/utils/tokenEstimator.d.ts +0 -28
  226. package/dist/utils/tokenEstimator.d.ts.map +0 -1
  227. package/dist/utils/tokenEstimator.js +0 -134
  228. package/dist/utils/tokenEstimator.js.map +0 -1
@@ -1 +1 @@
1
- {"version":3,"file":"developmentWorkflowTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/developmentWorkflowTemplate.ts"],"names":[],"mappings":"AAEA,wBAAgB,yBAAyB,IAAI,MAAM,CAsDlD"}
1
+ {"version":3,"file":"developmentWorkflowTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/developmentWorkflowTemplate.ts"],"names":[],"mappings":"AAAA,wBAAgB,yBAAyB,IAAI,MAAM,CAuClD"}
@@ -1,25 +1,8 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.renderDevelopmentWorkflow = renderDevelopmentWorkflow;
4
- const frontMatter_1 = require("./frontMatter");
5
4
  function renderDevelopmentWorkflow() {
6
- const frontMatter = (0, frontMatter_1.createFrontMatter)({
7
- id: 'development-workflow',
8
- goal: 'Document how the team builds, reviews, and ships code every day.',
9
- requiredInputs: [
10
- 'Branching and release policies',
11
- 'Package scripts and CI workflows',
12
- 'Code review expectations agreed upon by the team'
13
- ],
14
- successCriteria: [
15
- 'Branching guidance mirrors the default git strategy or CI configuration',
16
- 'Local development commands are copy/paste ready',
17
- 'Onboarding links point to living sources (boards, runbooks)'
18
- ],
19
- relatedAgents: ['documentation-writer', 'code-reviewer']
20
- });
21
- return `${frontMatter}
22
- <!-- ai-task:development-workflow -->
5
+ return `<!-- agent-update:start:development-workflow -->
23
6
  # Development Workflow
24
7
 
25
8
  Outline the day-to-day engineering process for this repository.
@@ -35,12 +18,13 @@ Outline the day-to-day engineering process for this repository.
35
18
 
36
19
  ## Code Review Expectations
37
20
  - Summarize review checklists and required approvals.
38
- - Reference [AGENTS.md](../AGENTS.md) for agent collaboration tips.
21
+ - Reference [AGENTS.md](../../AGENTS.md) for agent collaboration tips.
39
22
 
40
23
  ## Onboarding Tasks
41
24
  - Point newcomers to first issues or starter tickets.
42
25
  - Link to internal runbooks or dashboards.
43
26
 
27
+ <!-- agent-readonly:guidance -->
44
28
  ## AI Update Checklist
45
29
  1. Confirm branching/release steps with CI configuration and recent tags.
46
30
  2. Verify local commands against \`package.json\`; ensure flags and scripts still exist.
@@ -48,12 +32,13 @@ Outline the day-to-day engineering process for this repository.
48
32
  4. Refresh onboarding links (boards, dashboards) to their latest URLs.
49
33
  5. Highlight any manual steps that should become automation follow-ups.
50
34
 
35
+ <!-- agent-readonly:sources -->
51
36
  ## Acceptable Sources
52
37
  - CONTRIBUTING guidelines and \`AGENTS.md\`.
53
38
  - Build pipelines, branch protection rules, or release scripts.
54
39
  - Issue tracker boards used for onboarding or triage.
55
40
 
56
- <!-- /ai-task -->
41
+ <!-- agent-update:end -->
57
42
  `;
58
43
  }
59
44
  //# sourceMappingURL=developmentWorkflowTemplate.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"developmentWorkflowTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/developmentWorkflowTemplate.ts"],"names":[],"mappings":";;AAEA,8DAsDC;AAxDD,+CAAkD;AAElD,SAAgB,yBAAyB;IACvC,MAAM,WAAW,GAAG,IAAA,+BAAiB,EAAC;QACpC,EAAE,EAAE,sBAAsB;QAC1B,IAAI,EAAE,kEAAkE;QACxE,cAAc,EAAE;YACd,gCAAgC;YAChC,kCAAkC;YAClC,kDAAkD;SACnD;QACD,eAAe,EAAE;YACf,yEAAyE;YACzE,iDAAiD;YACjD,6DAA6D;SAC9D;QACD,aAAa,EAAE,CAAC,sBAAsB,EAAE,eAAe,CAAC;KACzD,CAAC,CAAC;IAEH,OAAO,GAAG,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoCtB,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"developmentWorkflowTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/developmentWorkflowTemplate.ts"],"names":[],"mappings":";;AAAA,8DAuCC;AAvCD,SAAgB,yBAAyB;IACvC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqCR,CAAC;AACF,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"glossaryTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/glossaryTemplate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAEvD,wBAAgB,cAAc,CAAC,QAAQ,EAAE,4BAA4B,GAAG,MAAM,CAkD7E"}
1
+ {"version":3,"file":"glossaryTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/glossaryTemplate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAEvD,wBAAgB,cAAc,CAAC,QAAQ,EAAE,4BAA4B,GAAG,MAAM,CAqC7E"}
@@ -1,55 +1,41 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.renderGlossary = renderGlossary;
4
- const frontMatter_1 = require("./frontMatter");
5
4
  function renderGlossary(_context) {
6
- const frontMatter = (0, frontMatter_1.createFrontMatter)({
7
- id: 'glossary',
8
- goal: 'Capture shared language, acronyms, domain entities, and user personas so newcomers and agents understand the problem space.',
9
- requiredInputs: [
10
- 'Business or product briefs that define the problem domain',
11
- 'Onboarding notes or internal wiki entries with terminology',
12
- 'Examples from issues/PRs where domain language appears'
13
- ],
14
- successCriteria: [
15
- 'Each term includes a concise definition plus why it matters to the codebase',
16
- 'Acronyms are expanded on first mention and linked to their origin',
17
- 'Personas or actors include their goals and interactions with the system'
18
- ],
19
- relatedAgents: ['documentation-writer', 'feature-developer']
20
- });
21
- return `${frontMatter}
22
- <!-- ai-task:glossary -->
5
+ return `
6
+ <!-- agent-update:start:glossary -->
23
7
  # Glossary & Domain Concepts
24
8
 
25
9
  List project-specific terminology, acronyms, domain entities, and user personas.
26
10
 
27
11
  ## Core Terms
28
- - <!-- ai-slot:term-one -->**Term** — Definition, relevance, and where it surfaces in the codebase.<!-- /ai-slot -->
29
- - <!-- ai-slot:term-two -->**Term** — Definition, domain context, related modules.<!-- /ai-slot -->
12
+ - <!-- agent-fill:term-one -->**Term** — Definition, relevance, and where it surfaces in the codebase.<!-- /agent-fill -->
13
+ - <!-- agent-fill:term-two -->**Term** — Definition, domain context, related modules.<!-- /agent-fill -->
30
14
 
31
15
  ## Acronyms & Abbreviations
32
- - <!-- ai-slot:acronym -->**ABC** — Expanded form; why we use it; associated services or APIs.<!-- /ai-slot -->
16
+ - <!-- agent-fill:acronym -->**ABC** — Expanded form; why we use it; associated services or APIs.<!-- /agent-fill -->
33
17
 
34
18
  ## Personas / Actors
35
- - <!-- ai-slot:persona -->**Persona Name** — Goals, key workflows, pain points addressed by the system.<!-- /ai-slot -->
19
+ - <!-- agent-fill:persona -->**Persona Name** — Goals, key workflows, pain points addressed by the system.<!-- /agent-fill -->
36
20
 
37
21
  ## Domain Rules & Invariants
38
22
  - Capture business rules, validation constraints, or compliance requirements that the code enforces.
39
23
  - Note any region, localization, or regulatory nuances.
40
24
 
25
+ <!-- agent-readonly:guidance -->
41
26
  ## AI Update Checklist
42
27
  1. Harvest terminology from recent PRs, issues, and discussions.
43
28
  2. Confirm definitions with product or domain experts when uncertain.
44
29
  3. Link terms to relevant docs or modules for deeper context.
45
30
  4. Remove or archive outdated concepts; flag unknown terms for follow-up.
46
31
 
32
+ <!-- agent-readonly:sources -->
47
33
  ## Acceptable Sources
48
34
  - Product requirement docs, RFCs, user research, or support tickets.
49
35
  - Service contracts, API schemas, data dictionaries.
50
36
  - Conversations with domain experts (summarize outcomes if applicable).
51
37
 
52
- <!-- /ai-task -->
38
+ <!-- agent-update:end -->
53
39
  `;
54
40
  }
55
41
  //# sourceMappingURL=glossaryTemplate.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"glossaryTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/glossaryTemplate.ts"],"names":[],"mappings":";;AAGA,wCAkDC;AArDD,+CAAkD;AAGlD,SAAgB,cAAc,CAAC,QAAsC;IACnE,MAAM,WAAW,GAAG,IAAA,+BAAiB,EAAC;QACpC,EAAE,EAAE,UAAU;QACd,IAAI,EAAE,6HAA6H;QACnI,cAAc,EAAE;YACd,2DAA2D;YAC3D,4DAA4D;YAC5D,wDAAwD;SACzD;QACD,eAAe,EAAE;YACf,6EAA6E;YAC7E,mEAAmE;YACnE,yEAAyE;SAC1E;QACD,aAAa,EAAE,CAAC,sBAAsB,EAAE,mBAAmB,CAAC;KAC7D,CAAC,CAAC;IAEH,OAAO,GAAG,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgCtB,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"glossaryTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/glossaryTemplate.ts"],"names":[],"mappings":";;AAEA,wCAqCC;AArCD,SAAgB,cAAc,CAAC,QAAsC;IAEnE,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkCR,CAAC;AACF,CAAC"}
@@ -7,5 +7,9 @@ export { renderGlossary } from './glossaryTemplate';
7
7
  export { renderDataFlow } from './dataFlowTemplate';
8
8
  export { renderSecurity } from './securityTemplate';
9
9
  export { renderToolingGuide } from './toolingTemplate';
10
+ export { renderApiReference } from './apiReferenceTemplate';
11
+ export { renderTroubleshooting } from './troubleshootingTemplate';
12
+ export { renderMigration } from './migrationTemplate';
13
+ export { renderOnboarding } from './onboardingTemplate';
10
14
  export type { DocumentationTemplateContext, GuideMeta, DirectoryStat } from './types';
11
15
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,YAAY,EAAE,4BAA4B,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,4BAA4B,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC"}
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.renderToolingGuide = exports.renderSecurity = exports.renderDataFlow = exports.renderGlossary = exports.renderTestingStrategy = exports.renderDevelopmentWorkflow = exports.renderArchitectureNotes = exports.renderProjectOverview = exports.renderIndex = void 0;
3
+ exports.renderOnboarding = exports.renderMigration = exports.renderTroubleshooting = exports.renderApiReference = exports.renderToolingGuide = exports.renderSecurity = exports.renderDataFlow = exports.renderGlossary = exports.renderTestingStrategy = exports.renderDevelopmentWorkflow = exports.renderArchitectureNotes = exports.renderProjectOverview = exports.renderIndex = void 0;
4
4
  var indexTemplate_1 = require("./indexTemplate");
5
5
  Object.defineProperty(exports, "renderIndex", { enumerable: true, get: function () { return indexTemplate_1.renderIndex; } });
6
6
  var projectOverviewTemplate_1 = require("./projectOverviewTemplate");
@@ -19,4 +19,12 @@ var securityTemplate_1 = require("./securityTemplate");
19
19
  Object.defineProperty(exports, "renderSecurity", { enumerable: true, get: function () { return securityTemplate_1.renderSecurity; } });
20
20
  var toolingTemplate_1 = require("./toolingTemplate");
21
21
  Object.defineProperty(exports, "renderToolingGuide", { enumerable: true, get: function () { return toolingTemplate_1.renderToolingGuide; } });
22
+ var apiReferenceTemplate_1 = require("./apiReferenceTemplate");
23
+ Object.defineProperty(exports, "renderApiReference", { enumerable: true, get: function () { return apiReferenceTemplate_1.renderApiReference; } });
24
+ var troubleshootingTemplate_1 = require("./troubleshootingTemplate");
25
+ Object.defineProperty(exports, "renderTroubleshooting", { enumerable: true, get: function () { return troubleshootingTemplate_1.renderTroubleshooting; } });
26
+ var migrationTemplate_1 = require("./migrationTemplate");
27
+ Object.defineProperty(exports, "renderMigration", { enumerable: true, get: function () { return migrationTemplate_1.renderMigration; } });
28
+ var onboardingTemplate_1 = require("./onboardingTemplate");
29
+ Object.defineProperty(exports, "renderOnboarding", { enumerable: true, get: function () { return onboardingTemplate_1.renderOnboarding; } });
22
30
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/index.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAArC,4GAAA,WAAW,OAAA;AACpB,qEAAkE;AAAzD,gIAAA,qBAAqB,OAAA;AAC9B,+DAAiE;AAAxD,+HAAA,uBAAuB,OAAA;AAChC,6EAA0E;AAAjE,wIAAA,yBAAyB,OAAA;AAClC,qDAA0D;AAAjD,wHAAA,qBAAqB,OAAA;AAC9B,uDAAoD;AAA3C,kHAAA,cAAc,OAAA;AACvB,uDAAoD;AAA3C,kHAAA,cAAc,OAAA;AACvB,uDAAoD;AAA3C,kHAAA,cAAc,OAAA;AACvB,qDAAuD;AAA9C,qHAAA,kBAAkB,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/index.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAArC,4GAAA,WAAW,OAAA;AACpB,qEAAkE;AAAzD,gIAAA,qBAAqB,OAAA;AAC9B,+DAAiE;AAAxD,+HAAA,uBAAuB,OAAA;AAChC,6EAA0E;AAAjE,wIAAA,yBAAyB,OAAA;AAClC,qDAA0D;AAAjD,wHAAA,qBAAqB,OAAA;AAC9B,uDAAoD;AAA3C,kHAAA,cAAc,OAAA;AACvB,uDAAoD;AAA3C,kHAAA,cAAc,OAAA;AACvB,uDAAoD;AAA3C,kHAAA,cAAc,OAAA;AACvB,qDAAuD;AAA9C,qHAAA,kBAAkB,OAAA;AAC3B,+DAA4D;AAAnD,0HAAA,kBAAkB,OAAA;AAC3B,qEAAkE;AAAzD,gIAAA,qBAAqB,OAAA;AAC9B,yDAAsD;AAA7C,oHAAA,eAAe,OAAA;AACxB,2DAAwD;AAA/C,sHAAA,gBAAgB,OAAA"}
@@ -1 +1 @@
1
- {"version":3,"file":"indexTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/indexTemplate.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAEvD,wBAAgB,WAAW,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CAmDzE"}
1
+ {"version":3,"file":"indexTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/indexTemplate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAEvD,wBAAgB,WAAW,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CAsCzE"}
@@ -1,31 +1,15 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.renderIndex = renderIndex;
4
- const frontMatter_1 = require("./frontMatter");
5
4
  const common_1 = require("./common");
6
5
  function renderIndex(context) {
7
- const frontMatter = (0, frontMatter_1.createFrontMatter)({
8
- id: 'docs-index',
9
- goal: 'Keep the documentation map accurate so contributors and agents land on the right guide quickly.',
10
- requiredInputs: [
11
- 'Current docs and agents directory listings',
12
- 'Recent additions or removals across documentation assets',
13
- 'Latest roadmap or release summary (if available)'
14
- ],
15
- successCriteria: [
16
- 'Each linked guide exists and reflects its stated purpose',
17
- 'Repository snapshot matches the real top-level structure',
18
- 'Update checklist is confirmed before closing the task'
19
- ],
20
- relatedAgents: ['documentation-writer', 'architect-specialist']
21
- });
22
6
  const directoryList = (0, common_1.formatDirectoryList)(context, false);
23
7
  const documentMap = (0, common_1.buildDocumentMapTable)(context.guides);
24
8
  const navigationList = context.guides
25
9
  .map(guide => `- [${guide.title}](./${guide.file})`)
26
10
  .join('\n') || '- *No guides selected.*';
27
- return `${frontMatter}
28
- <!-- ai-task:docs-index -->
11
+ return `
12
+ <!-- agent-update:start:docs-index -->
29
13
  # Documentation Index
30
14
 
31
15
  Welcome to the repository knowledge base. Start with the project overview, then dive into specific guides as needed.
@@ -39,18 +23,20 @@ ${directoryList || '*Top-level directories will appear here once the repository
39
23
  ## Document Map
40
24
  ${documentMap}
41
25
 
26
+ <!-- agent-readonly:guidance -->
42
27
  ## AI Update Checklist
43
28
  1. Gather context with \`git status -sb\` plus the latest commits touching \`docs/\` or \`agents/\`.
44
29
  2. Compare the current directory tree against the table above; add or retire rows accordingly.
45
30
  3. Update cross-links if guides moved or were renamed; keep anchor text concise.
46
31
  4. Record sources consulted inside the commit or PR description for traceability.
47
32
 
33
+ <!-- agent-readonly:sources -->
48
34
  ## Acceptable Sources
49
35
  - Repository tree and \`package.json\` scripts for canonical command names.
50
36
  - Maintainer-approved issues, RFCs, or product briefs referenced in the repo.
51
37
  - Release notes or changelog entries that announce documentation changes.
52
38
 
53
- <!-- /ai-task -->
39
+ <!-- agent-update:end -->
54
40
  `;
55
41
  }
56
42
  //# sourceMappingURL=indexTemplate.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"indexTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/indexTemplate.ts"],"names":[],"mappings":";;AAIA,kCAmDC;AAvDD,+CAAkD;AAClD,qCAAsE;AAGtE,SAAgB,WAAW,CAAC,OAAqC;IAC/D,MAAM,WAAW,GAAG,IAAA,+BAAiB,EAAC;QACpC,EAAE,EAAE,YAAY;QAChB,IAAI,EAAE,iGAAiG;QACvG,cAAc,EAAE;YACd,4CAA4C;YAC5C,0DAA0D;YAC1D,kDAAkD;SACnD;QACD,eAAe,EAAE;YACf,0DAA0D;YAC1D,0DAA0D;YAC1D,uDAAuD;SACxD;QACD,aAAa,EAAE,CAAC,sBAAsB,EAAE,sBAAsB,CAAC;KAChE,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,IAAA,4BAAmB,EAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC1D,MAAM,WAAW,GAAG,IAAA,8BAAqB,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1D,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM;SAClC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,KAAK,CAAC,KAAK,OAAO,KAAK,CAAC,IAAI,GAAG,CAAC;SACnD,IAAI,CAAC,IAAI,CAAC,IAAI,yBAAyB,CAAC;IAE3C,OAAO,GAAG,WAAW;;;;;;;EAOrB,cAAc;;;EAGd,aAAa,IAAI,mFAAmF;;;EAGpG,WAAW;;;;;;;;;;;;;;CAcZ,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"indexTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/indexTemplate.ts"],"names":[],"mappings":";;AAGA,kCAsCC;AAzCD,qCAAsE;AAGtE,SAAgB,WAAW,CAAC,OAAqC;IAE/D,MAAM,aAAa,GAAG,IAAA,4BAAmB,EAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC1D,MAAM,WAAW,GAAG,IAAA,8BAAqB,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1D,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM;SAClC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,KAAK,CAAC,KAAK,OAAO,KAAK,CAAC,IAAI,GAAG,CAAC;SACnD,IAAI,CAAC,IAAI,CAAC,IAAI,yBAAyB,CAAC;IAE3C,OAAO;;;;;;;EAOP,cAAc;;;EAGd,aAAa,IAAI,mFAAmF;;;EAGpG,WAAW;;;;;;;;;;;;;;;;CAgBZ,CAAC;AACF,CAAC"}
@@ -0,0 +1,2 @@
1
+ export declare function renderMigration(): string;
2
+ //# sourceMappingURL=migrationTemplate.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"migrationTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/migrationTemplate.ts"],"names":[],"mappings":"AACA,wBAAgB,eAAe,IAAI,MAAM,CAkaxC"}