@ai-coders/context 0.3.1 → 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.
- package/README.md +25 -23
- package/dist/generators/agents/agentConfig.d.ts.map +1 -1
- package/dist/generators/agents/agentConfig.js +42 -0
- package/dist/generators/agents/agentConfig.js.map +1 -1
- package/dist/generators/agents/agentGenerator.d.ts +0 -1
- package/dist/generators/agents/agentGenerator.d.ts.map +1 -1
- package/dist/generators/agents/agentGenerator.js +7 -47
- package/dist/generators/agents/agentGenerator.js.map +1 -1
- package/dist/generators/agents/agentTypes.d.ts +1 -1
- package/dist/generators/agents/agentTypes.d.ts.map +1 -1
- package/dist/generators/agents/agentTypes.js +4 -1
- package/dist/generators/agents/agentTypes.js.map +1 -1
- package/dist/generators/agents/templates/indexTemplate.d.ts.map +1 -1
- package/dist/generators/agents/templates/indexTemplate.js +2 -1
- package/dist/generators/agents/templates/indexTemplate.js.map +1 -1
- package/dist/generators/agents/templates/playbookTemplate.d.ts.map +1 -1
- package/dist/generators/agents/templates/playbookTemplate.js +39 -3
- package/dist/generators/agents/templates/playbookTemplate.js.map +1 -1
- package/dist/generators/documentation/documentationGenerator.d.ts +3 -1
- package/dist/generators/documentation/documentationGenerator.d.ts.map +1 -1
- package/dist/generators/documentation/documentationGenerator.js +88 -15
- package/dist/generators/documentation/documentationGenerator.js.map +1 -1
- package/dist/generators/documentation/guideRegistry.js +8 -8
- package/dist/generators/documentation/guideRegistry.js.map +1 -1
- package/dist/generators/documentation/templates/apiReferenceTemplate.d.ts +2 -0
- package/dist/generators/documentation/templates/apiReferenceTemplate.d.ts.map +1 -0
- package/dist/generators/documentation/templates/apiReferenceTemplate.js +490 -0
- package/dist/generators/documentation/templates/apiReferenceTemplate.js.map +1 -0
- package/dist/generators/documentation/templates/architectureTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/architectureTemplate.js +27 -27
- package/dist/generators/documentation/templates/architectureTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/common.js +2 -2
- package/dist/generators/documentation/templates/common.js.map +1 -1
- package/dist/generators/documentation/templates/dataFlowTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/dataFlowTemplate.js +5 -20
- package/dist/generators/documentation/templates/dataFlowTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/developmentWorkflowTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/developmentWorkflowTemplate.js +5 -20
- package/dist/generators/documentation/templates/developmentWorkflowTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/glossaryTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/glossaryTemplate.js +9 -23
- package/dist/generators/documentation/templates/glossaryTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/index.d.ts +4 -0
- package/dist/generators/documentation/templates/index.d.ts.map +1 -1
- package/dist/generators/documentation/templates/index.js +9 -1
- package/dist/generators/documentation/templates/index.js.map +1 -1
- package/dist/generators/documentation/templates/indexTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/indexTemplate.js +5 -19
- package/dist/generators/documentation/templates/indexTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/migrationTemplate.d.ts +2 -0
- package/dist/generators/documentation/templates/migrationTemplate.d.ts.map +1 -0
- package/dist/generators/documentation/templates/migrationTemplate.js +422 -0
- package/dist/generators/documentation/templates/migrationTemplate.js.map +1 -0
- package/dist/generators/documentation/templates/onboardingTemplate.d.ts +2 -0
- package/dist/generators/documentation/templates/onboardingTemplate.d.ts.map +1 -0
- package/dist/generators/documentation/templates/onboardingTemplate.js +431 -0
- package/dist/generators/documentation/templates/onboardingTemplate.js.map +1 -0
- package/dist/generators/documentation/templates/projectOverviewTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/projectOverviewTemplate.js +22 -25
- package/dist/generators/documentation/templates/projectOverviewTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/securityTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/securityTemplate.js +5 -19
- package/dist/generators/documentation/templates/securityTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/testingTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/testingTemplate.js +5 -19
- package/dist/generators/documentation/templates/testingTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/toolingTemplate.d.ts.map +1 -1
- package/dist/generators/documentation/templates/toolingTemplate.js +6 -20
- package/dist/generators/documentation/templates/toolingTemplate.js.map +1 -1
- package/dist/generators/documentation/templates/troubleshootingTemplate.d.ts +2 -0
- package/dist/generators/documentation/templates/troubleshootingTemplate.d.ts.map +1 -0
- package/dist/generators/documentation/templates/troubleshootingTemplate.js +292 -0
- package/dist/generators/documentation/templates/troubleshootingTemplate.js.map +1 -0
- package/dist/generators/plans/templates/indexTemplate.d.ts.map +1 -1
- package/dist/generators/plans/templates/indexTemplate.js +3 -2
- package/dist/generators/plans/templates/indexTemplate.js.map +1 -1
- package/dist/generators/plans/templates/planTemplate.d.ts.map +1 -1
- package/dist/generators/plans/templates/planTemplate.js +74 -3
- package/dist/generators/plans/templates/planTemplate.js.map +1 -1
- package/dist/generators/shared/generatorUtils.d.ts +1 -1
- package/dist/generators/shared/generatorUtils.d.ts.map +1 -1
- package/dist/generators/shared/generatorUtils.js +1 -1
- package/dist/generators/shared/generatorUtils.js.map +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +46 -1000
- package/dist/index.js.map +1 -1
- package/dist/prompts/defaults.d.ts +2 -2
- package/dist/prompts/defaults.d.ts.map +1 -1
- package/dist/prompts/defaults.js +11 -11
- package/dist/services/baseLLMClient.d.ts +3 -3
- package/dist/services/baseLLMClient.d.ts.map +1 -1
- package/dist/services/baseLLMClient.js +44 -5
- package/dist/services/baseLLMClient.js.map +1 -1
- package/dist/services/fill/fillService.d.ts +0 -4
- package/dist/services/fill/fillService.d.ts.map +1 -1
- package/dist/services/fill/fillService.js +6 -54
- package/dist/services/fill/fillService.js.map +1 -1
- package/dist/services/init/initService.d.ts +2 -2
- package/dist/services/init/initService.d.ts.map +1 -1
- package/dist/services/init/initService.js +45 -15
- package/dist/services/init/initService.js.map +1 -1
- package/dist/services/llmClientFactory.d.ts +2 -8
- package/dist/services/llmClientFactory.d.ts.map +1 -1
- package/dist/services/llmClientFactory.js +10 -96
- package/dist/services/llmClientFactory.js.map +1 -1
- package/dist/services/openRouterClient.d.ts +0 -3
- package/dist/services/openRouterClient.d.ts.map +1 -1
- package/dist/services/openRouterClient.js +2 -49
- package/dist/services/openRouterClient.js.map +1 -1
- package/dist/services/plan/planService.d.ts +2 -4
- package/dist/services/plan/planService.d.ts.map +1 -1
- package/dist/services/plan/planService.js +3 -12
- package/dist/services/plan/planService.js.map +1 -1
- package/dist/services/shared/llmConfig.d.ts.map +1 -1
- package/dist/services/shared/llmConfig.js +11 -53
- package/dist/services/shared/llmConfig.js.map +1 -1
- package/dist/types.d.ts +7 -2
- package/dist/types.d.ts.map +1 -1
- package/dist/utils/fileMapper.d.ts +1 -1
- package/dist/utils/fileMapper.d.ts.map +1 -1
- package/dist/utils/fileMapper.js +40 -19
- package/dist/utils/fileMapper.js.map +1 -1
- package/dist/utils/i18n.d.ts +11 -32
- package/dist/utils/i18n.d.ts.map +1 -1
- package/dist/utils/i18n.js +22 -64
- package/dist/utils/i18n.js.map +1 -1
- package/package.json +9 -12
- package/prompts/update_plan_prompt.md +4 -5
- package/prompts/update_scaffold_prompt.md +7 -8
- package/dist/generators/agents/contextUtils.d.ts +0 -8
- package/dist/generators/agents/contextUtils.d.ts.map +0 -1
- package/dist/generators/agents/contextUtils.js +0 -15
- package/dist/generators/agents/contextUtils.js.map +0 -1
- package/dist/generators/agents/promptFormatter.d.ts +0 -9
- package/dist/generators/agents/promptFormatter.d.ts.map +0 -1
- package/dist/generators/agents/promptFormatter.js +0 -84
- package/dist/generators/agents/promptFormatter.js.map +0 -1
- package/dist/generators/analyzers/codebaseAnalyzer.d.ts +0 -45
- package/dist/generators/analyzers/codebaseAnalyzer.d.ts.map +0 -1
- package/dist/generators/analyzers/codebaseAnalyzer.js +0 -293
- package/dist/generators/analyzers/codebaseAnalyzer.js.map +0 -1
- package/dist/generators/analyzers/index.d.ts +0 -3
- package/dist/generators/analyzers/index.d.ts.map +0 -1
- package/dist/generators/analyzers/index.js +0 -6
- package/dist/generators/analyzers/index.js.map +0 -1
- package/dist/generators/documentation/documentationTemplates.d.ts +0 -21
- package/dist/generators/documentation/documentationTemplates.d.ts.map +0 -1
- package/dist/generators/documentation/documentationTemplates.js +0 -359
- package/dist/generators/documentation/documentationTemplates.js.map +0 -1
- package/dist/generators/documentation/documentationTypes.d.ts +0 -11
- package/dist/generators/documentation/documentationTypes.d.ts.map +0 -1
- package/dist/generators/documentation/documentationTypes.js +0 -22
- package/dist/generators/documentation/documentationTypes.js.map +0 -1
- package/dist/generators/documentation/documentationUtils.d.ts +0 -7
- package/dist/generators/documentation/documentationUtils.d.ts.map +0 -1
- package/dist/generators/documentation/documentationUtils.js +0 -28
- package/dist/generators/documentation/documentationUtils.js.map +0 -1
- package/dist/generators/documentation/incrementalDocumentationGenerator.d.ts +0 -33
- package/dist/generators/documentation/incrementalDocumentationGenerator.d.ts.map +0 -1
- package/dist/generators/documentation/incrementalDocumentationGenerator.js +0 -400
- package/dist/generators/documentation/incrementalDocumentationGenerator.js.map +0 -1
- package/dist/generators/documentation/templates.d.ts +0 -31
- package/dist/generators/documentation/templates.d.ts.map +0 -1
- package/dist/generators/documentation/templates.js +0 -566
- package/dist/generators/documentation/templates.js.map +0 -1
- package/dist/generators/guidelines/agentIntegration.d.ts +0 -43
- package/dist/generators/guidelines/agentIntegration.d.ts.map +0 -1
- package/dist/generators/guidelines/agentIntegration.js +0 -157
- package/dist/generators/guidelines/agentIntegration.js.map +0 -1
- package/dist/generators/guidelines/guidelineTypes.d.ts +0 -40
- package/dist/generators/guidelines/guidelineTypes.d.ts.map +0 -1
- package/dist/generators/guidelines/guidelineTypes.js +0 -144
- package/dist/generators/guidelines/guidelineTypes.js.map +0 -1
- package/dist/generators/guidelines/guidelinesAnalyzer.d.ts +0 -30
- package/dist/generators/guidelines/guidelinesAnalyzer.d.ts.map +0 -1
- package/dist/generators/guidelines/guidelinesAnalyzer.js +0 -263
- package/dist/generators/guidelines/guidelinesAnalyzer.js.map +0 -1
- package/dist/generators/guidelines/guidelinesGenerator.d.ts +0 -30
- package/dist/generators/guidelines/guidelinesGenerator.d.ts.map +0 -1
- package/dist/generators/guidelines/guidelinesGenerator.js +0 -249
- package/dist/generators/guidelines/guidelinesGenerator.js.map +0 -1
- package/dist/generators/guidelines/guidelinesTemplates.d.ts +0 -23
- package/dist/generators/guidelines/guidelinesTemplates.d.ts.map +0 -1
- package/dist/generators/guidelines/guidelinesTemplates.js +0 -304
- package/dist/generators/guidelines/guidelinesTemplates.js.map +0 -1
- package/dist/generators/guidelines/index.d.ts +0 -6
- package/dist/generators/guidelines/index.d.ts.map +0 -1
- package/dist/generators/guidelines/index.js +0 -16
- package/dist/generators/guidelines/index.js.map +0 -1
- package/dist/generators/moduleGrouper.d.ts +0 -14
- package/dist/generators/moduleGrouper.d.ts.map +0 -1
- package/dist/generators/moduleGrouper.js +0 -82
- package/dist/generators/moduleGrouper.js.map +0 -1
- package/dist/generators/projectAnalyzer.d.ts +0 -14
- package/dist/generators/projectAnalyzer.d.ts.map +0 -1
- package/dist/generators/projectAnalyzer.js +0 -217
- package/dist/generators/projectAnalyzer.js.map +0 -1
- package/dist/services/changeAnalyzer.d.ts +0 -44
- package/dist/services/changeAnalyzer.d.ts.map +0 -1
- package/dist/services/changeAnalyzer.js +0 -344
- package/dist/services/changeAnalyzer.js.map +0 -1
- package/dist/utils/interactiveMode.d.ts +0 -21
- package/dist/utils/interactiveMode.d.ts.map +0 -1
- package/dist/utils/interactiveMode.js +0 -737
- package/dist/utils/interactiveMode.js.map +0 -1
- package/dist/utils/tokenEstimator.d.ts +0 -28
- package/dist/utils/tokenEstimator.d.ts.map +0 -1
- package/dist/utils/tokenEstimator.js +0 -134
- package/dist/utils/tokenEstimator.js.map +0 -1
|
@@ -1,39 +1,37 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.renderArchitectureNotes = renderArchitectureNotes;
|
|
4
|
-
const frontMatter_1 = require("./frontMatter");
|
|
5
4
|
const common_1 = require("./common");
|
|
6
5
|
function renderArchitectureNotes(context) {
|
|
7
|
-
const frontMatter = (0, frontMatter_1.createFrontMatter)({
|
|
8
|
-
id: 'architecture-notes',
|
|
9
|
-
goal: 'Describe how the system is assembled, key trade-offs, and active constraints.',
|
|
10
|
-
requiredInputs: [
|
|
11
|
-
'Recent architectural decisions or ADRs',
|
|
12
|
-
'Observed service/module boundaries in the codebase',
|
|
13
|
-
'Dependency graphs or build tooling insights'
|
|
14
|
-
],
|
|
15
|
-
successCriteria: [
|
|
16
|
-
'Decision list covers the most influential trade-offs',
|
|
17
|
-
'Risks capture active constraints or technical debt',
|
|
18
|
-
'Links to diagrams or monitors are up to date'
|
|
19
|
-
],
|
|
20
|
-
relatedAgents: ['architect-specialist', 'backend-specialist']
|
|
21
|
-
});
|
|
22
|
-
const defaultSections = [
|
|
23
|
-
'System boundaries and integration points',
|
|
24
|
-
'Primary modules and their responsibilities',
|
|
25
|
-
'Data flow between major components',
|
|
26
|
-
'Dependencies worth highlighting'
|
|
27
|
-
];
|
|
28
6
|
const directorySnapshot = (0, common_1.formatDirectoryStats)(context.directoryStats);
|
|
29
|
-
|
|
30
|
-
|
|
7
|
+
const coreComponentsSection = directorySnapshot || '- *Add notes for each core component or module.*';
|
|
8
|
+
return `<!-- agent-update:start:architecture-notes -->
|
|
31
9
|
# Architecture Notes
|
|
32
10
|
|
|
33
11
|
> TODO: Describe how the system is assembled and why the current design exists.
|
|
34
12
|
|
|
35
|
-
##
|
|
36
|
-
|
|
13
|
+
## System Architecture Overview
|
|
14
|
+
- Summarize the top-level topology (monolith, modular service, microservices) and deployment model.
|
|
15
|
+
- Highlight how requests traverse the system and where control pivots between layers.
|
|
16
|
+
|
|
17
|
+
## Core System Components
|
|
18
|
+
${coreComponentsSection}
|
|
19
|
+
|
|
20
|
+
## Internal System Boundaries
|
|
21
|
+
- Document seams between domains, bounded contexts, or service ownership.
|
|
22
|
+
- Note data ownership, synchronization strategies, and shared contract enforcement.
|
|
23
|
+
|
|
24
|
+
## System Integration Points
|
|
25
|
+
- Map inbound interfaces (APIs, events, webhooks) and the modules that own them.
|
|
26
|
+
- Capture orchestration touchpoints where this system calls or coordinates other internal services.
|
|
27
|
+
|
|
28
|
+
## External Service Dependencies
|
|
29
|
+
- List SaaS platforms, third-party APIs, or infrastructure services the system relies on.
|
|
30
|
+
- Describe authentication methods, rate limits, and failure considerations for each dependency.
|
|
31
|
+
|
|
32
|
+
## Key Decisions & Trade-offs
|
|
33
|
+
- Summarize architectural decisions, experiments, or ADR outcomes that shape the current design.
|
|
34
|
+
- Reference supporting documents and explain why selected approaches won over alternatives.
|
|
37
35
|
|
|
38
36
|
## Diagrams
|
|
39
37
|
- Link architectural diagrams or add mermaid definitions here.
|
|
@@ -44,6 +42,7 @@ ${defaultSections.map(item => `- ${item}`).join('\n')}
|
|
|
44
42
|
## Top Directories Snapshot
|
|
45
43
|
${directorySnapshot}
|
|
46
44
|
|
|
45
|
+
<!-- agent-readonly:guidance -->
|
|
47
46
|
## AI Update Checklist
|
|
48
47
|
1. Review ADRs, design docs, or major PRs for architectural changes.
|
|
49
48
|
2. Verify that each documented decision still holds; mark superseded choices clearly.
|
|
@@ -51,6 +50,7 @@ ${directorySnapshot}
|
|
|
51
50
|
4. Update Risks & Constraints with active incident learnings or TODO debt.
|
|
52
51
|
5. Link any new diagrams or dashboards referenced in recent work.
|
|
53
52
|
|
|
53
|
+
<!-- agent-readonly:sources -->
|
|
54
54
|
## Acceptable Sources
|
|
55
55
|
- ADR folders, \`/docs/architecture\` notes, or RFC threads.
|
|
56
56
|
- Dependency visualisations from build tooling or scripts.
|
|
@@ -60,7 +60,7 @@ ${directorySnapshot}
|
|
|
60
60
|
- [Project Overview](./project-overview.md)
|
|
61
61
|
- Update [agents/README.md](../agents/README.md) when architecture changes.
|
|
62
62
|
|
|
63
|
-
<!--
|
|
63
|
+
<!-- agent-update:end -->
|
|
64
64
|
`;
|
|
65
65
|
}
|
|
66
66
|
//# sourceMappingURL=architectureTemplate.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"architectureTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/architectureTemplate.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"architectureTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/architectureTemplate.ts"],"names":[],"mappings":";;AAGA,0DA6DC;AA/DD,qCAAgD;AAEhD,SAAgB,uBAAuB,CAAC,OAAqC;IAC3E,MAAM,iBAAiB,GAAG,IAAA,6BAAoB,EAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACvE,MAAM,qBAAqB,GAAG,iBAAiB,IAAI,kDAAkD,CAAC;IAEtG,OAAO;;;;;;;;;;EAUP,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;EAyBrB,iBAAiB;;;;;;;;;;;;;;;;;;;;;CAqBlB,CAAC;AACF,CAAC"}
|
|
@@ -27,13 +27,13 @@ function formatDirectoryList(context, includePlaceholders) {
|
|
|
27
27
|
return `- \`${dir}/\``;
|
|
28
28
|
}
|
|
29
29
|
const slotId = slugify(dir);
|
|
30
|
-
return `- <!--
|
|
30
|
+
return `- <!-- agent-fill:directory-${slotId} -->\`${dir}/\` — TODO: Describe the purpose of this directory.<!-- /agent-fill -->`;
|
|
31
31
|
})
|
|
32
32
|
.join('\n');
|
|
33
33
|
}
|
|
34
34
|
function buildDocumentMapTable(guides) {
|
|
35
35
|
const rows = guides.map(meta => `| ${meta.title} | \`${meta.file}\` | ${meta.marker} | ${meta.primaryInputs} |`);
|
|
36
|
-
return ['| Guide | File |
|
|
36
|
+
return ['| Guide | File | AI Marker | Primary Inputs |', '| --- | --- | --- | --- |', ...rows].join('\n');
|
|
37
37
|
}
|
|
38
38
|
function formatDirectoryStats(stats) {
|
|
39
39
|
if (!stats.length) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/common.ts"],"names":[],"mappings":";;AAWA,kDAuBC;AAED,sDAGC;AAED,oDAQC;AAED,8DAMC;AAED,0BAKC;AA9DD,MAAM,kBAAkB,GAA2B;IACjD,GAAG,EAAE,8CAA8C;IACnD,IAAI,EAAE,yDAAyD;IAC/D,IAAI,EAAE,6CAA6C;IACnD,MAAM,EAAE,iCAAiC;IACzC,KAAK,EAAE,+BAA+B;IACtC,QAAQ,EAAE,gCAAgC;CAC3C,CAAC;AAEF,SAAgB,mBAAmB,CACjC,OAAqC,EACrC,mBAA4B;IAE5B,IAAI,OAAO,CAAC,mBAAmB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7C,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,OAAO,CAAC,mBAAmB;SAC/B,GAAG,CAAC,GAAG,CAAC,EAAE;QACT,MAAM,WAAW,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;QAC5C,IAAI,WAAW,EAAE,CAAC;YAChB,OAAO,OAAO,GAAG,SAAS,WAAW,EAAE,CAAC;QAC1C,CAAC;QAED,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACzB,OAAO,OAAO,GAAG,KAAK,CAAC;QACzB,CAAC;QAED,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5B,OAAO,
|
|
1
|
+
{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/common.ts"],"names":[],"mappings":";;AAWA,kDAuBC;AAED,sDAGC;AAED,oDAQC;AAED,8DAMC;AAED,0BAKC;AA9DD,MAAM,kBAAkB,GAA2B;IACjD,GAAG,EAAE,8CAA8C;IACnD,IAAI,EAAE,yDAAyD;IAC/D,IAAI,EAAE,6CAA6C;IACnD,MAAM,EAAE,iCAAiC;IACzC,KAAK,EAAE,+BAA+B;IACtC,QAAQ,EAAE,gCAAgC;CAC3C,CAAC;AAEF,SAAgB,mBAAmB,CACjC,OAAqC,EACrC,mBAA4B;IAE5B,IAAI,OAAO,CAAC,mBAAmB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7C,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,OAAO,CAAC,mBAAmB;SAC/B,GAAG,CAAC,GAAG,CAAC,EAAE;QACT,MAAM,WAAW,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;QAC5C,IAAI,WAAW,EAAE,CAAC;YAChB,OAAO,OAAO,GAAG,SAAS,WAAW,EAAE,CAAC;QAC1C,CAAC;QAED,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACzB,OAAO,OAAO,GAAG,KAAK,CAAC;QACzB,CAAC;QAED,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5B,OAAO,+BAA+B,MAAM,SAAS,GAAG,yEAAyE,CAAC;IACpI,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,SAAgB,qBAAqB,CAAC,MAA8C;IAClF,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,IAAI,QAAQ,IAAI,CAAC,MAAM,MAAM,IAAI,CAAC,aAAa,IAAI,CAAC,CAAC;IACjH,OAAO,CAAC,+CAA+C,EAAE,2BAA2B,EAAE,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5G,CAAC;AAED,SAAgB,oBAAoB,CAAC,KAAsB;IACzD,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAClB,OAAO,4BAA4B,CAAC;IACtC,CAAC;IAED,OAAO,KAAK;SACT,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,IAAI,CAAC,IAAI,uBAAuB,IAAI,CAAC,SAAS,QAAQ,CAAC;SAC1E,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,SAAgB,yBAAyB,CAAC,WAAqB;IAC7D,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QACxB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,OAAO,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACzD,CAAC;AAED,SAAgB,OAAO,CAAC,KAAa;IACnC,OAAO,KAAK;SACT,WAAW,EAAE;SACb,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;SAC3B,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;AAC7B,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dataFlowTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/dataFlowTemplate.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"dataFlowTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/dataFlowTemplate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAGvD,wBAAgB,cAAc,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CAkC5E"}
|
|
@@ -1,26 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.renderDataFlow = renderDataFlow;
|
|
4
|
-
const frontMatter_1 = require("./frontMatter");
|
|
5
4
|
const common_1 = require("./common");
|
|
6
5
|
function renderDataFlow(context) {
|
|
7
|
-
|
|
8
|
-
id: 'data-flow',
|
|
9
|
-
goal: 'Describe how information moves through the system and where it integrates with external services.',
|
|
10
|
-
requiredInputs: [
|
|
11
|
-
'Architecture diagrams or sequence flows',
|
|
12
|
-
'Integration specs (APIs, queues, webhooks, third-party services)',
|
|
13
|
-
'Notes on batch jobs, schedulers, or ETL processes'
|
|
14
|
-
],
|
|
15
|
-
successCriteria: [
|
|
16
|
-
'Highlights inbound, internal, and outbound flows',
|
|
17
|
-
'Documents transformation points and trust boundaries',
|
|
18
|
-
'Identifies failure modes and retry/backoff behaviour'
|
|
19
|
-
],
|
|
20
|
-
relatedAgents: ['architect-specialist', 'backend-specialist']
|
|
21
|
-
});
|
|
22
|
-
return `${frontMatter}
|
|
23
|
-
<!-- ai-task:data-flow -->
|
|
6
|
+
return `<!-- agent-update:start:data-flow -->
|
|
24
7
|
# Data Flow & Integrations
|
|
25
8
|
|
|
26
9
|
Explain how data enters, moves through, and exits the system, including interactions with external services.
|
|
@@ -32,24 +15,26 @@ Explain how data enters, moves through, and exits the system, including interact
|
|
|
32
15
|
- Describe how modules within ${(0, common_1.formatInlineDirectoryList)(context.topLevelDirectories)} collaborate (queues, events, RPC calls, shared databases).
|
|
33
16
|
|
|
34
17
|
## External Integrations
|
|
35
|
-
- <!--
|
|
18
|
+
- <!-- agent-fill:integration -->**Integration** — Purpose, authentication, payload shapes, retry strategy.<!-- /agent-fill -->
|
|
36
19
|
|
|
37
20
|
## Observability & Failure Modes
|
|
38
21
|
- Metrics, traces, or logs that monitor the flow.
|
|
39
22
|
- Backoff, dead-letter, or compensating actions when downstream systems fail.
|
|
40
23
|
|
|
24
|
+
<!-- agent-readonly:guidance -->
|
|
41
25
|
## AI Update Checklist
|
|
42
26
|
1. Validate flows against the latest integration contracts or diagrams.
|
|
43
27
|
2. Update authentication, scopes, or rate limits when they change.
|
|
44
28
|
3. Capture recent incidents or lessons learned that influenced reliability.
|
|
45
29
|
4. Link to runbooks or dashboards used during triage.
|
|
46
30
|
|
|
31
|
+
<!-- agent-readonly:sources -->
|
|
47
32
|
## Acceptable Sources
|
|
48
33
|
- Architecture diagrams, ADRs, integration playbooks.
|
|
49
34
|
- API specs, queue/topic definitions, infrastructure code.
|
|
50
35
|
- Postmortems or incident reviews impacting data movement.
|
|
51
36
|
|
|
52
|
-
<!--
|
|
37
|
+
<!-- agent-update:end -->
|
|
53
38
|
`;
|
|
54
39
|
}
|
|
55
40
|
//# sourceMappingURL=dataFlowTemplate.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dataFlowTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/dataFlowTemplate.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"dataFlowTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/dataFlowTemplate.ts"],"names":[],"mappings":";;AAGA,wCAkCC;AApCD,qCAAqD;AAErD,SAAgB,cAAc,CAAC,OAAqC;IAClE,OAAO;;;;;;;;;gCASuB,IAAA,kCAAyB,EAAC,OAAO,CAAC,mBAAmB,CAAC;;;;;;;;;;;;;;;;;;;;;;;CAuBrF,CAAC;AACF,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"developmentWorkflowTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/developmentWorkflowTemplate.ts"],"names":[],"mappings":"
|
|
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
|
-
|
|
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](
|
|
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
|
-
<!--
|
|
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":";;
|
|
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":"
|
|
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
|
-
|
|
7
|
-
|
|
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
|
-
- <!--
|
|
29
|
-
- <!--
|
|
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
|
-
- <!--
|
|
16
|
+
- <!-- agent-fill:acronym -->**ABC** — Expanded form; why we use it; associated services or APIs.<!-- /agent-fill -->
|
|
33
17
|
|
|
34
18
|
## Personas / Actors
|
|
35
|
-
- <!--
|
|
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
|
-
<!--
|
|
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":";;
|
|
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":"
|
|
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
|
|
28
|
-
<!--
|
|
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
|
-
<!--
|
|
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":";;
|
|
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 @@
|
|
|
1
|
+
{"version":3,"file":"migrationTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/migrationTemplate.ts"],"names":[],"mappings":"AACA,wBAAgB,eAAe,IAAI,MAAM,CAkaxC"}
|