@ai-coders/context 0.1.0 → 0.3.0

package/dist/generators/documentation/templates/architectureTemplate.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderArchitectureNotes = renderArchitectureNotes;
+const frontMatter_1 = require("./frontMatter");
+const common_1 = require("./common");
+function renderArchitectureNotes(context) {
+    const frontMatter = (0, frontMatter_1.createFrontMatter)({
+        id: 'architecture-notes',
+        goal: 'Describe how the system is assembled, key trade-offs, and active constraints.',
+        requiredInputs: [
+            'Recent architectural decisions or ADRs',
+            'Observed service/module boundaries in the codebase',
+            'Dependency graphs or build tooling insights'
+        ],
+        successCriteria: [
+            'Decision list covers the most influential trade-offs',
+            'Risks capture active constraints or technical debt',
+            'Links to diagrams or monitors are up to date'
+        ],
+        relatedAgents: ['architect-specialist', 'backend-specialist']
+    });
+    const defaultSections = [
+        'System boundaries and integration points',
+        'Primary modules and their responsibilities',
+        'Data flow between major components',
+        'Dependencies worth highlighting'
+    ];
+    const directorySnapshot = (0, common_1.formatDirectoryStats)(context.directoryStats);
+    return `${frontMatter}
+<!-- ai-task:architecture-notes -->
+# Architecture Notes
+
+> TODO: Describe how the system is assembled and why the current design exists.
+
+## Decisions To Record
+${defaultSections.map(item => `- ${item}`).join('\n')}
+
+## Diagrams
+- Link architectural diagrams or add mermaid definitions here.
+
+## Risks & Constraints
+- Document performance constraints, scaling considerations, or external system assumptions.
+
+## Top Directories Snapshot
+${directorySnapshot}
+
+## AI Update Checklist
+1. Review ADRs, design docs, or major PRs for architectural changes.
+2. Verify that each documented decision still holds; mark superseded choices clearly.
+3. Capture upstream/downstream impacts (APIs, events, data flows).
+4. Update Risks & Constraints with active incident learnings or TODO debt.
+5. Link any new diagrams or dashboards referenced in recent work.
+
+## Acceptable Sources
+- ADR folders, \`/docs/architecture\` notes, or RFC threads.
+- Dependency visualisations from build tooling or scripts.
+- Issue tracker discussions vetted by maintainers.
+
+## Related Resources
+- [Project Overview](./project-overview.md)
+- Update [agents/README.md](../agents/README.md) when architecture changes.
+
+<!-- /ai-task -->
+`;
+}
+//# sourceMappingURL=architectureTemplate.js.map

package/dist/generators/documentation/templates/architectureTemplate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"architectureTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/architectureTemplate.ts"],"names":[],"mappings":";;AAIA,0DA8DC;AAlED,+CAAkD;AAElD,qCAAgD;AAEhD,SAAgB,uBAAuB,CAAC,OAAqC;IAC3E,MAAM,WAAW,GAAG,IAAA,+BAAiB,EAAC;QACpC,EAAE,EAAE,oBAAoB;QACxB,IAAI,EAAE,+EAA+E;QACrF,cAAc,EAAE;YACd,wCAAwC;YACxC,oDAAoD;YACpD,6CAA6C;SAC9C;QACD,eAAe,EAAE;YACf,sDAAsD;YACtD,oDAAoD;YACpD,8CAA8C;SAC/C;QACD,aAAa,EAAE,CAAC,sBAAsB,EAAE,oBAAoB,CAAC;KAC9D,CAAC,CAAC;IAEH,MAAM,eAAe,GAAG;QACtB,0CAA0C;QAC1C,4CAA4C;QAC5C,oCAAoC;QACpC,iCAAiC;KAClC,CAAC;IAEF,MAAM,iBAAiB,GAAG,IAAA,6BAAoB,EAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IAEvE,OAAO,GAAG,WAAW;;;;;;;EAOrB,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;;;;;EASnD,iBAAiB;;;;;;;;;;;;;;;;;;;CAmBlB,CAAC;AACF,CAAC"}

package/dist/generators/documentation/templates/common.d.ts

@@ -0,0 +1,7 @@
+import { DirectoryStat, DocumentationTemplateContext } from './types';
+export declare function formatDirectoryList(context: DocumentationTemplateContext, includePlaceholders: boolean): string;
+export declare function buildDocumentMapTable(guides: DocumentationTemplateContext['guides']): string;
+export declare function formatDirectoryStats(stats: DirectoryStat[]): string;
+export declare function formatInlineDirectoryList(directories: string[]): string;
+export declare function slugify(value: string): string;
+//# sourceMappingURL=common.d.ts.map

package/dist/generators/documentation/templates/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAWtE,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,4BAA4B,EACrC,mBAAmB,EAAE,OAAO,GAC3B,MAAM,CAoBR;AAED,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,4BAA4B,CAAC,QAAQ,CAAC,GAAG,MAAM,CAG5F;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,aAAa,EAAE,GAAG,MAAM,CAQnE;AAED,wBAAgB,yBAAyB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,MAAM,CAMvE;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAK7C"}

package/dist/generators/documentation/templates/common.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatDirectoryList = formatDirectoryList;
+exports.buildDocumentMapTable = buildDocumentMapTable;
+exports.formatDirectoryStats = formatDirectoryStats;
+exports.formatInlineDirectoryList = formatInlineDirectoryList;
+exports.slugify = slugify;
+const KNOWN_DESCRIPTIONS = {
+    src: 'TypeScript source files and CLI entrypoints.',
+    dist: 'Compiled JavaScript output generated by the build step.',
+    docs: 'Living documentation produced by this tool.',
+    agents: 'AI agent playbooks and prompts.',
+    tests: 'Automated tests and fixtures.',
+    packages: 'Workspace packages or modules.'
+};
+function formatDirectoryList(context, includePlaceholders) {
+    if (context.topLevelDirectories.length === 0) {
+        return '';
+    }
+    return context.topLevelDirectories
+        .map(dir => {
+        const description = KNOWN_DESCRIPTIONS[dir];
+        if (description) {
+            return `- \`${dir}/\` — ${description}`;
+        }
+        if (!includePlaceholders) {
+            return `- \`${dir}/\``;
+        }
+        const slotId = slugify(dir);
+        return `- <!-- ai-slot:directory-${slotId} -->\`${dir}/\` — TODO: Describe the purpose of this directory.<!-- /ai-slot -->`;
+    })
+        .join('\n');
+}
+function buildDocumentMapTable(guides) {
+    const rows = guides.map(meta => `| ${meta.title} | \`${meta.file}\` | ${meta.marker} | ${meta.primaryInputs} |`);
+    return ['| Guide | File | Task Marker | Primary Inputs |', '| --- | --- | --- | --- |', ...rows].join('\n');
+}
+function formatDirectoryStats(stats) {
+    if (!stats.length) {
+        return '*No directories detected.*';
+    }
+    return stats
+        .map(stat => `- \`${stat.name}/\` — approximately ${stat.fileCount} files`)
+        .join('\n');
+}
+function formatInlineDirectoryList(directories) {
+    if (!directories.length) {
+        return '`n/a`';
+    }
+    return directories.map(dir => `\`${dir}\``).join(', ');
+}
+function slugify(value) {
+    return value
+        .toLowerCase()
+        .replace(/[^a-z0-9]+/g, '-')
+        .replace(/^-+|-+$/g, '');
+}
+//# sourceMappingURL=common.js.map

package/dist/generators/documentation/templates/common.js.map

@@ -0,0 +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,4BAA4B,MAAM,SAAS,GAAG,sEAAsE,CAAC;IAC9H,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,iDAAiD,EAAE,2BAA2B,EAAE,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9G,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"}

package/dist/generators/documentation/templates/dataFlowTemplate.d.ts

@@ -0,0 +1,3 @@
+import { DocumentationTemplateContext } from './types';
+export declare function renderDataFlow(context: DocumentationTemplateContext): string;
+//# sourceMappingURL=dataFlowTemplate.d.ts.map

package/dist/generators/documentation/templates/dataFlowTemplate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataFlowTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/dataFlowTemplate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAGvD,wBAAgB,cAAc,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CAiD5E"}

package/dist/generators/documentation/templates/dataFlowTemplate.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderDataFlow = renderDataFlow;
+const frontMatter_1 = require("./frontMatter");
+const common_1 = require("./common");
+function renderDataFlow(context) {
+    const frontMatter = (0, frontMatter_1.createFrontMatter)({
+        id: 'data-flow',
+        goal: 'Describe how information moves through the system and where it integrates with external services.',
+        requiredInputs: [
+            'Architecture diagrams or sequence flows',
+            'Integration specs (APIs, queues, webhooks, third-party services)',
+            'Notes on batch jobs, schedulers, or ETL processes'
+        ],
+        successCriteria: [
+            'Highlights inbound, internal, and outbound flows',
+            'Documents transformation points and trust boundaries',
+            'Identifies failure modes and retry/backoff behaviour'
+        ],
+        relatedAgents: ['architect-specialist', 'backend-specialist']
+    });
+    return `${frontMatter}
+<!-- ai-task:data-flow -->
+# Data Flow & Integrations
+
+Explain how data enters, moves through, and exits the system, including interactions with external services.
+
+## High-level Flow
+- Summarize the primary pipeline from input to output. Reference diagrams or embed Mermaid definitions when available.
+
+## Internal Movement
+- Describe how modules within ${(0, common_1.formatInlineDirectoryList)(context.topLevelDirectories)} collaborate (queues, events, RPC calls, shared databases).
+
+## External Integrations
+- <!-- ai-slot:integration -->**Integration** — Purpose, authentication, payload shapes, retry strategy.<!-- /ai-slot -->
+
+## Observability & Failure Modes
+- Metrics, traces, or logs that monitor the flow.
+- Backoff, dead-letter, or compensating actions when downstream systems fail.
+
+## AI Update Checklist
+1. Validate flows against the latest integration contracts or diagrams.
+2. Update authentication, scopes, or rate limits when they change.
+3. Capture recent incidents or lessons learned that influenced reliability.
+4. Link to runbooks or dashboards used during triage.
+
+## Acceptable Sources
+- Architecture diagrams, ADRs, integration playbooks.
+- API specs, queue/topic definitions, infrastructure code.
+- Postmortems or incident reviews impacting data movement.
+
+<!-- /ai-task -->
+`;
+}
+//# sourceMappingURL=dataFlowTemplate.js.map

package/dist/generators/documentation/templates/dataFlowTemplate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataFlowTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/dataFlowTemplate.ts"],"names":[],"mappings":";;AAIA,wCAiDC;AArDD,+CAAkD;AAElD,qCAAqD;AAErD,SAAgB,cAAc,CAAC,OAAqC;IAClE,MAAM,WAAW,GAAG,IAAA,+BAAiB,EAAC;QACpC,EAAE,EAAE,WAAW;QACf,IAAI,EAAE,mGAAmG;QACzG,cAAc,EAAE;YACd,yCAAyC;YACzC,kEAAkE;YAClE,mDAAmD;SACpD;QACD,eAAe,EAAE;YACf,kDAAkD;YAClD,sDAAsD;YACtD,sDAAsD;SACvD;QACD,aAAa,EAAE,CAAC,sBAAsB,EAAE,oBAAoB,CAAC;KAC9D,CAAC,CAAC;IAEH,OAAO,GAAG,WAAW;;;;;;;;;;gCAUS,IAAA,kCAAyB,EAAC,OAAO,CAAC,mBAAmB,CAAC;;;;;;;;;;;;;;;;;;;;;CAqBrF,CAAC;AACF,CAAC"}

package/dist/generators/documentation/templates/developmentWorkflowTemplate.d.ts

@@ -0,0 +1,2 @@
+export declare function renderDevelopmentWorkflow(): string;
+//# sourceMappingURL=developmentWorkflowTemplate.d.ts.map

package/dist/generators/documentation/templates/developmentWorkflowTemplate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"developmentWorkflowTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/developmentWorkflowTemplate.ts"],"names":[],"mappings":"AAEA,wBAAgB,yBAAyB,IAAI,MAAM,CAsDlD"}

package/dist/generators/documentation/templates/developmentWorkflowTemplate.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderDevelopmentWorkflow = renderDevelopmentWorkflow;
+const frontMatter_1 = require("./frontMatter");
+function renderDevelopmentWorkflow() {
+    const frontMatter = (0, frontMatter_1.createFrontMatter)({
+        id: 'development-workflow',
+        goal: 'Document how the team builds, reviews, and ships code every day.',
+        requiredInputs: [
+            'Branching and release policies',
+            'Package scripts and CI workflows',
+            'Code review expectations agreed upon by the team'
+        ],
+        successCriteria: [
+            'Branching guidance mirrors the default git strategy or CI configuration',
+            'Local development commands are copy/paste ready',
+            'Onboarding links point to living sources (boards, runbooks)'
+        ],
+        relatedAgents: ['documentation-writer', 'code-reviewer']
+    });
+    return `${frontMatter}
+<!-- ai-task:development-workflow -->
+# Development Workflow
+
+Outline the day-to-day engineering process for this repository.
+
+## Branching & Releases
+- Describe the branching model (e.g., trunk-based, Git Flow).
+- Note release cadence and tagging conventions.
+
+## Local Development
+- Commands to install dependencies: \`npm install\`
+- Run the CLI locally: \`npm run dev\`
+- Build for distribution: \`npm run build\`
+
+## Code Review Expectations
+- Summarize review checklists and required approvals.
+- Reference [AGENTS.md](../AGENTS.md) for agent collaboration tips.
+
+## Onboarding Tasks
+- Point newcomers to first issues or starter tickets.
+- Link to internal runbooks or dashboards.
+
+## AI Update Checklist
+1. Confirm branching/release steps with CI configuration and recent tags.
+2. Verify local commands against \`package.json\`; ensure flags and scripts still exist.
+3. Capture review requirements (approvers, checks) from contributing docs or repository settings.
+4. Refresh onboarding links (boards, dashboards) to their latest URLs.
+5. Highlight any manual steps that should become automation follow-ups.
+
+## Acceptable Sources
+- CONTRIBUTING guidelines and \`AGENTS.md\`.
+- Build pipelines, branch protection rules, or release scripts.
+- Issue tracker boards used for onboarding or triage.
+
+<!-- /ai-task -->
+`;
+}
+//# sourceMappingURL=developmentWorkflowTemplate.js.map

package/dist/generators/documentation/templates/developmentWorkflowTemplate.js.map

@@ -0,0 +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"}

package/dist/generators/documentation/templates/frontMatter.d.ts

@@ -0,0 +1,11 @@
+interface FrontMatterConfig {
+    id: string;
+    goal: string;
+    requiredInputs: string[];
+    successCriteria: string[];
+    relatedAgents?: string[];
+}
+export declare function createFrontMatter(config: FrontMatterConfig): string;
+export declare function escapeYaml(value: string): string;
+export {};
+//# sourceMappingURL=frontMatter.d.ts.map

package/dist/generators/documentation/templates/frontMatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frontMatter.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/frontMatter.ts"],"names":[],"mappings":"AAAA,UAAU,iBAAiB;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAoBnE;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEhD"}

package/dist/generators/documentation/templates/frontMatter.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createFrontMatter = createFrontMatter;
+exports.escapeYaml = escapeYaml;
+function createFrontMatter(config) {
+    const lines = ['---'];
+    lines.push(`id: ${config.id}`);
+    lines.push(`ai_update_goal: "${escapeYaml(config.goal)}"`);
+    lines.push('required_inputs:');
+    config.requiredInputs.forEach(item => {
+        lines.push(`  - "${escapeYaml(item)}"`);
+    });
+    lines.push('success_criteria:');
+    config.successCriteria.forEach(item => {
+        lines.push(`  - "${escapeYaml(item)}"`);
+    });
+    if (config.relatedAgents && config.relatedAgents.length > 0) {
+        lines.push('related_agents:');
+        config.relatedAgents.forEach(agent => {
+            lines.push(`  - "${escapeYaml(agent)}"`);
+        });
+    }
+    lines.push('---\n');
+    return lines.join('\n');
+}
+function escapeYaml(value) {
+    return value.replace(/"/g, '\\"');
+}
+//# sourceMappingURL=frontMatter.js.map

package/dist/generators/documentation/templates/frontMatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"frontMatter.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/frontMatter.ts"],"names":[],"mappings":";;AAQA,8CAoBC;AAED,gCAEC;AAxBD,SAAgB,iBAAiB,CAAC,MAAyB;IACzD,MAAM,KAAK,GAAa,CAAC,KAAK,CAAC,CAAC;IAChC,KAAK,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;IAC/B,KAAK,CAAC,IAAI,CAAC,oBAAoB,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3D,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC/B,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACnC,KAAK,CAAC,IAAI,CAAC,QAAQ,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IACH,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAChC,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACpC,KAAK,CAAC,IAAI,CAAC,QAAQ,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IACH,IAAI,MAAM,CAAC,aAAa,IAAI,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5D,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC9B,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACnC,KAAK,CAAC,IAAI,CAAC,QAAQ,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAgB,UAAU,CAAC,KAAa;IACtC,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACpC,CAAC"}

package/dist/generators/documentation/templates/glossaryTemplate.d.ts

@@ -0,0 +1,3 @@
+import { DocumentationTemplateContext } from './types';
+export declare function renderGlossary(_context: DocumentationTemplateContext): string;
+//# sourceMappingURL=glossaryTemplate.d.ts.map

package/dist/generators/documentation/templates/glossaryTemplate.d.ts.map

@@ -0,0 +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"}

package/dist/generators/documentation/templates/glossaryTemplate.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderGlossary = renderGlossary;
+const frontMatter_1 = require("./frontMatter");
+function renderGlossary(_context) {
+    const frontMatter = (0, frontMatter_1.createFrontMatter)({
+        id: 'glossary',
+        goal: 'Capture shared language, acronyms, domain entities, and user personas so newcomers and agents understand the problem space.',
+        requiredInputs: [
+            'Business or product briefs that define the problem domain',
+            'Onboarding notes or internal wiki entries with terminology',
+            'Examples from issues/PRs where domain language appears'
+        ],
+        successCriteria: [
+            'Each term includes a concise definition plus why it matters to the codebase',
+            'Acronyms are expanded on first mention and linked to their origin',
+            'Personas or actors include their goals and interactions with the system'
+        ],
+        relatedAgents: ['documentation-writer', 'feature-developer']
+    });
+    return `${frontMatter}
+<!-- ai-task:glossary -->
+# Glossary & Domain Concepts
+
+List project-specific terminology, acronyms, domain entities, and user personas.
+
+## Core Terms
+- <!-- ai-slot:term-one -->**Term** — Definition, relevance, and where it surfaces in the codebase.<!-- /ai-slot -->
+- <!-- ai-slot:term-two -->**Term** — Definition, domain context, related modules.<!-- /ai-slot -->
+
+## Acronyms & Abbreviations
+- <!-- ai-slot:acronym -->**ABC** — Expanded form; why we use it; associated services or APIs.<!-- /ai-slot -->
+
+## Personas / Actors
+- <!-- ai-slot:persona -->**Persona Name** — Goals, key workflows, pain points addressed by the system.<!-- /ai-slot -->
+
+## Domain Rules & Invariants
+- Capture business rules, validation constraints, or compliance requirements that the code enforces.
+- Note any region, localization, or regulatory nuances.
+
+## AI Update Checklist
+1. Harvest terminology from recent PRs, issues, and discussions.
+2. Confirm definitions with product or domain experts when uncertain.
+3. Link terms to relevant docs or modules for deeper context.
+4. Remove or archive outdated concepts; flag unknown terms for follow-up.
+
+## Acceptable Sources
+- Product requirement docs, RFCs, user research, or support tickets.
+- Service contracts, API schemas, data dictionaries.
+- Conversations with domain experts (summarize outcomes if applicable).
+
+<!-- /ai-task -->
+`;
+}
+//# sourceMappingURL=glossaryTemplate.js.map

package/dist/generators/documentation/templates/glossaryTemplate.js.map

@@ -0,0 +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"}

package/dist/generators/documentation/templates/index.d.ts

@@ -0,0 +1,11 @@
+export { renderIndex } from './indexTemplate';
+export { renderProjectOverview } from './projectOverviewTemplate';
+export { renderArchitectureNotes } from './architectureTemplate';
+export { renderDevelopmentWorkflow } from './developmentWorkflowTemplate';
+export { renderTestingStrategy } from './testingTemplate';
+export { renderGlossary } from './glossaryTemplate';
+export { renderDataFlow } from './dataFlowTemplate';
+export { renderSecurity } from './securityTemplate';
+export { renderToolingGuide } from './toolingTemplate';
+export type { DocumentationTemplateContext, GuideMeta, DirectoryStat } from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/generators/documentation/templates/index.d.ts.map

@@ -0,0 +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"}

package/dist/generators/documentation/templates/index.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderToolingGuide = exports.renderSecurity = exports.renderDataFlow = exports.renderGlossary = exports.renderTestingStrategy = exports.renderDevelopmentWorkflow = exports.renderArchitectureNotes = exports.renderProjectOverview = exports.renderIndex = void 0;
+var indexTemplate_1 = require("./indexTemplate");
+Object.defineProperty(exports, "renderIndex", { enumerable: true, get: function () { return indexTemplate_1.renderIndex; } });
+var projectOverviewTemplate_1 = require("./projectOverviewTemplate");
+Object.defineProperty(exports, "renderProjectOverview", { enumerable: true, get: function () { return projectOverviewTemplate_1.renderProjectOverview; } });
+var architectureTemplate_1 = require("./architectureTemplate");
+Object.defineProperty(exports, "renderArchitectureNotes", { enumerable: true, get: function () { return architectureTemplate_1.renderArchitectureNotes; } });
+var developmentWorkflowTemplate_1 = require("./developmentWorkflowTemplate");
+Object.defineProperty(exports, "renderDevelopmentWorkflow", { enumerable: true, get: function () { return developmentWorkflowTemplate_1.renderDevelopmentWorkflow; } });
+var testingTemplate_1 = require("./testingTemplate");
+Object.defineProperty(exports, "renderTestingStrategy", { enumerable: true, get: function () { return testingTemplate_1.renderTestingStrategy; } });
+var glossaryTemplate_1 = require("./glossaryTemplate");
+Object.defineProperty(exports, "renderGlossary", { enumerable: true, get: function () { return glossaryTemplate_1.renderGlossary; } });
+var dataFlowTemplate_1 = require("./dataFlowTemplate");
+Object.defineProperty(exports, "renderDataFlow", { enumerable: true, get: function () { return dataFlowTemplate_1.renderDataFlow; } });
+var securityTemplate_1 = require("./securityTemplate");
+Object.defineProperty(exports, "renderSecurity", { enumerable: true, get: function () { return securityTemplate_1.renderSecurity; } });
+var toolingTemplate_1 = require("./toolingTemplate");
+Object.defineProperty(exports, "renderToolingGuide", { enumerable: true, get: function () { return toolingTemplate_1.renderToolingGuide; } });
+//# sourceMappingURL=index.js.map

package/dist/generators/documentation/templates/index.js.map

@@ -0,0 +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"}

package/dist/generators/documentation/templates/indexTemplate.d.ts

@@ -0,0 +1,3 @@
+import { DocumentationTemplateContext } from './types';
+export declare function renderIndex(context: DocumentationTemplateContext): string;
+//# sourceMappingURL=indexTemplate.d.ts.map

package/dist/generators/documentation/templates/indexTemplate.d.ts.map

@@ -0,0 +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"}

package/dist/generators/documentation/templates/indexTemplate.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderIndex = renderIndex;
+const frontMatter_1 = require("./frontMatter");
+const common_1 = require("./common");
+function renderIndex(context) {
+    const frontMatter = (0, frontMatter_1.createFrontMatter)({
+        id: 'docs-index',
+        goal: 'Keep the documentation map accurate so contributors and agents land on the right guide quickly.',
+        requiredInputs: [
+            'Current docs and agents directory listings',
+            'Recent additions or removals across documentation assets',
+            'Latest roadmap or release summary (if available)'
+        ],
+        successCriteria: [
+            'Each linked guide exists and reflects its stated purpose',
+            'Repository snapshot matches the real top-level structure',
+            'Update checklist is confirmed before closing the task'
+        ],
+        relatedAgents: ['documentation-writer', 'architect-specialist']
+    });
+    const directoryList = (0, common_1.formatDirectoryList)(context, false);
+    const documentMap = (0, common_1.buildDocumentMapTable)(context.guides);
+    const navigationList = context.guides
+        .map(guide => `- [${guide.title}](./${guide.file})`)
+        .join('\n') || '- *No guides selected.*';
+    return `${frontMatter}
+<!-- ai-task:docs-index -->
+# Documentation Index
+
+Welcome to the repository knowledge base. Start with the project overview, then dive into specific guides as needed.
+
+## Core Guides
+${navigationList}
+
+## Repository Snapshot
+${directoryList || '*Top-level directories will appear here once the repository contains subfolders.*'}
+
+## Document Map
+${documentMap}
+
+## AI Update Checklist
+1. Gather context with \`git status -sb\` plus the latest commits touching \`docs/\` or \`agents/\`.
+2. Compare the current directory tree against the table above; add or retire rows accordingly.
+3. Update cross-links if guides moved or were renamed; keep anchor text concise.
+4. Record sources consulted inside the commit or PR description for traceability.
+
+## Acceptable Sources
+- Repository tree and \`package.json\` scripts for canonical command names.
+- Maintainer-approved issues, RFCs, or product briefs referenced in the repo.
+- Release notes or changelog entries that announce documentation changes.
+
+<!-- /ai-task -->
+`;
+}
+//# sourceMappingURL=indexTemplate.js.map

package/dist/generators/documentation/templates/indexTemplate.js.map

@@ -0,0 +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"}

package/dist/generators/documentation/templates/projectOverviewTemplate.d.ts

@@ -0,0 +1,3 @@
+import { DocumentationTemplateContext } from './types';
+export declare function renderProjectOverview(context: DocumentationTemplateContext): string;
+//# sourceMappingURL=projectOverviewTemplate.d.ts.map

package/dist/generators/documentation/templates/projectOverviewTemplate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"projectOverviewTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/projectOverviewTemplate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAGvD,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CA+DnF"}

package/dist/generators/documentation/templates/projectOverviewTemplate.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderProjectOverview = renderProjectOverview;
+const frontMatter_1 = require("./frontMatter");
+const common_1 = require("./common");
+function renderProjectOverview(context) {
+    const frontMatter = (0, frontMatter_1.createFrontMatter)({
+        id: 'project-overview',
+        goal: 'Explain why the project exists, who it serves, and how to get productive quickly.',
+        requiredInputs: [
+            'Latest product or roadmap brief',
+            'Repository metadata (README highlights, package manifests)',
+            'List of stakeholders or domain experts for verification'
+        ],
+        successCriteria: [
+            'Quick Facts mirror current tooling, stack, and entry points',
+            'Directory map explains where primary capabilities live',
+            'Next steps point to authoritative specs or dashboards'
+        ],
+        relatedAgents: ['documentation-writer', 'architect-specialist']
+    });
+    const directoryList = (0, common_1.formatDirectoryList)(context, true);
+    const languageSummary = context.primaryLanguages.length > 0
+        ? context.primaryLanguages.map(lang => `- ${lang.extension} (${lang.count} files)`).join('\n')
+        : '- Language mix pending analysis.';
+    return `${frontMatter}
+<!-- ai-task:project-overview -->
+# Project Overview
+
+> TODO: Summarize the problem this project solves and who benefits from it.
+
+## Quick Facts
+- Root path: \`${context.repoStructure.rootPath}\`
+- Primary languages detected:
+${languageSummary}
+
+## Directory Map
+${directoryList || '*Add a short description for each relevant directory.*'}
+
+## Technology Signals
+- Highlight frameworks, runtimes, state management patterns, data layers, and cross-service communication patterns detected in the repository.
+- Note build tooling, linting, and formatting infrastructure they should be aware of.
+- Call out external services (APIs, queues, cloud resources) and their integration points.
+
+## Getting Started Checklist
+1. Install dependencies with \`npm install\`.
+2. Explore the CLI by running \`npm run dev\`.
+3. Review [Development Workflow](./development-workflow.md) for day-to-day tasks.
+
+## Next Steps
+Capture product positioning, key stakeholders, and links to external documentation or product specs here.
+
+## AI Update Checklist
+1. Review roadmap items or issues labelled “release” to confirm current goals.
+2. Cross-check Quick Facts against \`package.json\` and environment docs.
+3. Refresh the Directory Map to reflect new or retired modules; keep guidance actionable.
+4. Link critical dashboards, specs, or runbooks used by the team.
+5. Flag any details that require human confirmation (e.g., stakeholder ownership).
+
+## Acceptable Sources
+- Recent commits, release notes, or ADRs describing high-level changes.
+- Product requirement documents linked from this repository.
+- Confirmed statements from maintainers or product leads.
+
+<!-- /ai-task -->
+`;
+}
+//# sourceMappingURL=projectOverviewTemplate.js.map

package/dist/generators/documentation/templates/projectOverviewTemplate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"projectOverviewTemplate.js","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/projectOverviewTemplate.ts"],"names":[],"mappings":";;AAIA,sDA+DC;AAnED,+CAAkD;AAElD,qCAA+C;AAE/C,SAAgB,qBAAqB,CAAC,OAAqC;IACzE,MAAM,WAAW,GAAG,IAAA,+BAAiB,EAAC;QACpC,EAAE,EAAE,kBAAkB;QACtB,IAAI,EAAE,mFAAmF;QACzF,cAAc,EAAE;YACd,iCAAiC;YACjC,4DAA4D;YAC5D,yDAAyD;SAC1D;QACD,eAAe,EAAE;YACf,6DAA6D;YAC7D,wDAAwD;YACxD,uDAAuD;SACxD;QACD,aAAa,EAAE,CAAC,sBAAsB,EAAE,sBAAsB,CAAC;KAChE,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,IAAA,4BAAmB,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACzD,MAAM,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC;QACzD,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAC9F,CAAC,CAAC,kCAAkC,CAAC;IAEvC,OAAO,GAAG,WAAW;;;;;;;iBAON,OAAO,CAAC,aAAa,CAAC,QAAQ;;EAE7C,eAAe;;;EAGf,aAAa,IAAI,wDAAwD;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4B1E,CAAC;AACF,CAAC"}

package/dist/generators/documentation/templates/securityTemplate.d.ts

@@ -0,0 +1,2 @@
+export declare function renderSecurity(): string;
+//# sourceMappingURL=securityTemplate.d.ts.map

package/dist/generators/documentation/templates/securityTemplate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"securityTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/securityTemplate.ts"],"names":[],"mappings":"AAEA,wBAAgB,cAAc,IAAI,MAAM,CAgDvC"}