@ai-coders/context 0.6.1 → 0.7.1

package/dist/generators/shared/structures/documentation/glossary.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.glossaryStructure = void 0;
+exports.glossaryStructure = {
+    fileType: 'doc',
+    documentName: 'glossary',
+    title: 'Glossary & Domain Concepts',
+    description: 'Project terminology, type definitions, domain entities, and business rules',
+    tone: 'technical',
+    audience: 'mixed',
+    sections: [
+        {
+            heading: 'Glossary & Domain Concepts',
+            order: 1,
+            contentType: 'prose',
+            guidance: 'List project-specific terminology, acronyms, domain entities, and user personas.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `This document defines project-specific terminology, concepts, and domain knowledge.
+
+Use this as a reference when encountering unfamiliar terms in the codebase or documentation.`,
+        },
+        {
+            heading: 'Type Definitions',
+            order: 2,
+            contentType: 'list',
+            guidance: 'List exported type definitions and interfaces with links to their locations.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `Key type definitions in this project:
+
+- **[TypeName]** — [Description] (\`src/types/path.ts\`)
+
+*See [\`codebase-map.json\`](./codebase-map.json) for complete type listings.*`,
+        },
+        {
+            heading: 'Enumerations',
+            order: 3,
+            contentType: 'list',
+            guidance: 'List exported enums with links to their locations.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `Enums defined in this project:
+
+- **[EnumName]** — [Description] (\`src/types/path.ts\`)
+
+*See [\`codebase-map.json\`](./codebase-map.json) for complete enum listings.*`,
+        },
+        {
+            heading: 'Core Terms',
+            order: 4,
+            contentType: 'list',
+            guidance: 'Define key terms, their relevance, and where they surface in the codebase.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `**[Term]**: [Definition and context]
+
+Add project-specific terminology here as the codebase evolves.`,
+        },
+        {
+            heading: 'Acronyms & Abbreviations',
+            order: 5,
+            contentType: 'list',
+            guidance: 'Expand abbreviations and note associated services or APIs.',
+            required: false,
+            headingLevel: 2,
+            defaultContent: `| Acronym | Expansion | Context |
+|---------|-----------|---------|
+| API | Application Programming Interface | External/internal interfaces |
+| CLI | Command Line Interface | User interaction |`,
+        },
+        {
+            heading: 'Personas / Actors',
+            order: 6,
+            contentType: 'prose',
+            guidance: 'Describe user goals, key workflows, and pain points addressed by the system.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Domain Rules & Invariants',
+            order: 7,
+            contentType: 'prose',
+            guidance: 'Capture business rules, validation constraints, or compliance requirements. Note region/localization nuances.',
+            required: false,
+            headingLevel: 2,
+        },
+    ],
+    linkTo: ['project-overview.md'],
+};
+//# sourceMappingURL=glossary.js.map

package/dist/generators/shared/structures/documentation/glossary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"glossary.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/glossary.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAsB;IAClD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,UAAU;IACxB,KAAK,EAAE,4BAA4B;IACnC,WAAW,EAAE,4EAA4E;IACzF,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,OAAO;IACjB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,4BAA4B;YACrC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,kFAAkF;YAC5F,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;6FAEuE;SACxF;QACD;YACE,OAAO,EAAE,kBAAkB;YAC3B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,8EAA8E;YACxF,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;+EAIyD;SAC1E;QACD;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,oDAAoD;YAC9D,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;+EAIyD;SAC1E;QACD;YACE,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,4EAA4E;YACtF,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;+DAEyC;SAC1D;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,4DAA4D;YACtE,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;oDAG8B;SAC/C;QACD;YACE,OAAO,EAAE,mBAAmB;YAC5B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,8EAA8E;YACxF,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,2BAA2B;YACpC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,+GAA+G;YACzH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;KACF;IACD,MAAM,EAAE,CAAC,qBAAqB,CAAC;CAChC,CAAC"}

package/dist/generators/shared/structures/documentation/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Documentation structure definitions
+ */
+export { projectOverviewStructure } from './projectOverview';
+export { architectureStructure } from './architecture';
+export { developmentWorkflowStructure } from './workflow';
+export { testingStrategyStructure } from './testing';
+export { toolingStructure } from './tooling';
+export { securityStructure } from './security';
+export { glossaryStructure } from './glossary';
+export { dataFlowStructure } from './dataFlow';
+export { onboardingStructure } from './onboarding';
+export { apiReferenceStructure } from './apiReference';
+export { migrationStructure } from './migration';
+export { troubleshootingStructure } from './troubleshooting';
+//# sourceMappingURL=index.d.ts.map

package/dist/generators/shared/structures/documentation/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/generators/shared/structures/documentation/index.js

@@ -0,0 +1,31 @@
+"use strict";
+/**
+ * Documentation structure definitions
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.troubleshootingStructure = exports.migrationStructure = exports.apiReferenceStructure = exports.onboardingStructure = exports.dataFlowStructure = exports.glossaryStructure = exports.securityStructure = exports.toolingStructure = exports.testingStrategyStructure = exports.developmentWorkflowStructure = exports.architectureStructure = exports.projectOverviewStructure = void 0;
+var projectOverview_1 = require("./projectOverview");
+Object.defineProperty(exports, "projectOverviewStructure", { enumerable: true, get: function () { return projectOverview_1.projectOverviewStructure; } });
+var architecture_1 = require("./architecture");
+Object.defineProperty(exports, "architectureStructure", { enumerable: true, get: function () { return architecture_1.architectureStructure; } });
+var workflow_1 = require("./workflow");
+Object.defineProperty(exports, "developmentWorkflowStructure", { enumerable: true, get: function () { return workflow_1.developmentWorkflowStructure; } });
+var testing_1 = require("./testing");
+Object.defineProperty(exports, "testingStrategyStructure", { enumerable: true, get: function () { return testing_1.testingStrategyStructure; } });
+var tooling_1 = require("./tooling");
+Object.defineProperty(exports, "toolingStructure", { enumerable: true, get: function () { return tooling_1.toolingStructure; } });
+var security_1 = require("./security");
+Object.defineProperty(exports, "securityStructure", { enumerable: true, get: function () { return security_1.securityStructure; } });
+var glossary_1 = require("./glossary");
+Object.defineProperty(exports, "glossaryStructure", { enumerable: true, get: function () { return glossary_1.glossaryStructure; } });
+var dataFlow_1 = require("./dataFlow");
+Object.defineProperty(exports, "dataFlowStructure", { enumerable: true, get: function () { return dataFlow_1.dataFlowStructure; } });
+var onboarding_1 = require("./onboarding");
+Object.defineProperty(exports, "onboardingStructure", { enumerable: true, get: function () { return onboarding_1.onboardingStructure; } });
+var apiReference_1 = require("./apiReference");
+Object.defineProperty(exports, "apiReferenceStructure", { enumerable: true, get: function () { return apiReference_1.apiReferenceStructure; } });
+var migration_1 = require("./migration");
+Object.defineProperty(exports, "migrationStructure", { enumerable: true, get: function () { return migration_1.migrationStructure; } });
+var troubleshooting_1 = require("./troubleshooting");
+Object.defineProperty(exports, "troubleshootingStructure", { enumerable: true, get: function () { return troubleshooting_1.troubleshootingStructure; } });
+//# sourceMappingURL=index.js.map

package/dist/generators/shared/structures/documentation/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,qDAA6D;AAApD,2HAAA,wBAAwB,OAAA;AACjC,+CAAuD;AAA9C,qHAAA,qBAAqB,OAAA;AAC9B,uCAA0D;AAAjD,wHAAA,4BAA4B,OAAA;AACrC,qCAAqD;AAA5C,mHAAA,wBAAwB,OAAA;AACjC,qCAA6C;AAApC,2GAAA,gBAAgB,OAAA;AACzB,uCAA+C;AAAtC,6GAAA,iBAAiB,OAAA;AAC1B,uCAA+C;AAAtC,6GAAA,iBAAiB,OAAA;AAC1B,uCAA+C;AAAtC,6GAAA,iBAAiB,OAAA;AAC1B,2CAAmD;AAA1C,iHAAA,mBAAmB,OAAA;AAC5B,+CAAuD;AAA9C,qHAAA,qBAAqB,OAAA;AAC9B,yCAAiD;AAAxC,+GAAA,kBAAkB,OAAA;AAC3B,qDAA6D;AAApD,2HAAA,wBAAwB,OAAA"}

package/dist/generators/shared/structures/documentation/migration.d.ts

@@ -0,0 +1,3 @@
+import { ScaffoldStructure } from '../types';
+export declare const migrationStructure: ScaffoldStructure;
+//# sourceMappingURL=migration.d.ts.map

package/dist/generators/shared/structures/documentation/migration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/migration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,kBAAkB,EAAE,iBA4GhC,CAAC"}

package/dist/generators/shared/structures/documentation/migration.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.migrationStructure = void 0;
+exports.migrationStructure = {
+    fileType: 'doc',
+    documentName: 'migration',
+    title: 'Migration Guide',
+    description: 'Complete guide for upgrading between versions, breaking changes, and data migration procedures',
+    tone: 'technical',
+    audience: 'developers',
+    sections: [
+        {
+            heading: 'Migration Guide',
+            order: 1,
+            contentType: 'prose',
+            guidance: 'Introduction explaining version support policy and the migration guide purpose.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Current Version & Support Policy',
+            order: 2,
+            contentType: 'prose',
+            guidance: 'Document latest version, release date, and version support lifecycle (how long each version receives support).',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Before You Migrate',
+            order: 3,
+            contentType: 'checklist',
+            guidance: 'Pre-migration checklist including backup, changelog review, staging test, dependency check, stakeholder notification, and rollback planning.',
+            exampleContent: '- [ ] Backup all data (database, file storage)\n- [ ] Review changelog for target version\n- [ ] Test migration in staging environment\n- [ ] Check dependency compatibility\n- [ ] Notify stakeholders\n- [ ] Plan rollback procedure\n- [ ] Schedule maintenance window',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'System Requirements',
+            order: 4,
+            contentType: 'list',
+            guidance: 'List minimum requirements for each version including Node.js, database, OS, memory, and disk space.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Migration Paths',
+            order: 5,
+            contentType: 'prose',
+            guidance: 'Document supported upgrade paths with breaking changes, step-by-step procedures with bash commands, and rollback instructions.',
+            exampleContent: 'For each major version upgrade: list breaking changes, provide detailed migration steps with code blocks, include rollback procedures',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Database Migrations',
+            order: 6,
+            contentType: 'prose',
+            guidance: 'Document database migration procedures including running migrations, creating custom migrations, and handling large datasets.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Data Transformation',
+            order: 7,
+            contentType: 'prose',
+            guidance: 'Document data transformation strategies including batch migration scripts and zero-downtime migration patterns.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Deprecation Timeline',
+            order: 8,
+            contentType: 'list',
+            guidance: 'List deprecated features and the timeline for removal with migration paths.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Backward Compatibility',
+            order: 9,
+            contentType: 'prose',
+            guidance: 'Explain compatibility mode and feature flags for managing transition between versions.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Common Issues & Solutions',
+            order: 10,
+            contentType: 'prose',
+            guidance: 'Document common migration issues and solutions including migration failures, data inconsistencies, and performance problems.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Verification & Testing',
+            order: 11,
+            contentType: 'list',
+            guidance: 'List scripts and tools for verifying migration success and testing application functionality.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Getting Help',
+            order: 12,
+            contentType: 'prose',
+            guidance: 'Provide support contact information and guidance for reporting migration issues.',
+            required: false,
+            headingLevel: 2,
+        },
+    ],
+    linkTo: ['development-workflow.md', 'architecture.md'],
+};
+//# sourceMappingURL=migration.js.map

package/dist/generators/shared/structures/documentation/migration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/migration.ts"],"names":[],"mappings":";;;AAEa,QAAA,kBAAkB,GAAsB;IACnD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,WAAW;IACzB,KAAK,EAAE,iBAAiB;IACxB,WAAW,EAAE,gGAAgG;IAC7G,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,YAAY;IACtB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,iBAAiB;YAC1B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,iFAAiF;YAC3F,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,kCAAkC;YAC3C,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,gHAAgH;YAC1H,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,oBAAoB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,WAAW;YACxB,QAAQ,EAAE,8IAA8I;YACxJ,cAAc,EAAE,2QAA2Q;YAC3R,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,qBAAqB;YAC9B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,qGAAqG;YAC/G,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,iBAAiB;YAC1B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,gIAAgI;YAC1I,cAAc,EAAE,uIAAuI;YACvJ,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,qBAAqB;YAC9B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,+HAA+H;YACzI,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,qBAAqB;YAC9B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,iHAAiH;YAC3H,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,sBAAsB;YAC/B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,6EAA6E;YACvF,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,wBAAwB;YACjC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,wFAAwF;YAClG,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,2BAA2B;YACpC,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,8HAA8H;YACxI,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,wBAAwB;YACjC,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,+FAA+F;YACzG,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,kFAAkF;YAC5F,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;KACF;IACD,MAAM,EAAE,CAAC,yBAAyB,EAAE,iBAAiB,CAAC;CACvD,CAAC"}

package/dist/generators/shared/structures/documentation/onboarding.d.ts

@@ -0,0 +1,3 @@
+import { ScaffoldStructure } from '../types';
+export declare const onboardingStructure: ScaffoldStructure;
+//# sourceMappingURL=onboarding.d.ts.map

package/dist/generators/shared/structures/documentation/onboarding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onboarding.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/onboarding.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,mBAAmB,EAAE,iBA8FjC,CAAC"}

package/dist/generators/shared/structures/documentation/onboarding.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onboardingStructure = void 0;
+exports.onboardingStructure = {
+    fileType: 'doc',
+    documentName: 'onboarding',
+    title: 'Onboarding Guide',
+    description: 'Complete guide for getting new team members productive, including access setup and first contributions',
+    tone: 'instructional',
+    audience: 'developers',
+    sections: [
+        {
+            heading: 'Onboarding Guide',
+            order: 1,
+            contentType: 'prose',
+            guidance: 'Welcome message and high-level overview of the onboarding process.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Day 1: Access & Accounts',
+            order: 2,
+            contentType: 'checklist',
+            guidance: 'Checklist for Day 1 access setup including email, chat, code repository, issue tracking, and documentation access.',
+            exampleContent: '- [ ] Email account - Verify access to team email\n- [ ] Chat/Communication - Join Slack/Teams and relevant channels\n- [ ] Code repository - GitHub access and SSH key configured\n- [ ] Issue tracking - Jira/GitHub Issues access\n- [ ] Documentation - Wiki/Confluence access',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Day 1-2: Development Environment',
+            order: 3,
+            contentType: 'list',
+            guidance: 'Step-by-step development environment setup with code blocks for installation and configuration commands.',
+            exampleContent: '- Install required software (Node.js, npm, Git, IDE)\n- Clone repository with example bash commands\n- Configure environment variables (.env file)\n- Run database migrations if applicable\n- Verify setup with test commands',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Day 2-3: Project Understanding',
+            order: 4,
+            contentType: 'list',
+            guidance: 'Reading list of core documentation and activities for understanding the codebase, team structure, and responsibilities.',
+            exampleContent: '- [ ] Read core documentation (Project Overview, Architecture, Development Workflow, Testing Strategy)\n- [ ] Explore project structure and main entry points\n- [ ] Meet team members and understand roles\n- [ ] Review recent pull requests for code standards',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Week 1: First Contributions',
+            order: 5,
+            contentType: 'list',
+            guidance: 'Guidance for making first code contributions, learning workflow, and setting up productivity tools.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Required Access & Permissions',
+            order: 6,
+            contentType: 'list',
+            guidance: 'List of accounts, access levels, and permissions needed for different roles (repository, deployments, databases, cloud resources).',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Team Communication',
+            order: 7,
+            contentType: 'list',
+            guidance: 'Document chat channels, recurring meetings, and communication guidelines.',
+            exampleContent: '- **Channels:** #engineering, #team-name, #deployments, #incidents\n- **Meetings:** Daily standup, Sprint planning, Retrospective, Team sync\n- **Guidelines:** Use threads, mention directly when needed, default to public channels',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Learning Resources',
+            order: 8,
+            contentType: 'list',
+            guidance: 'Links to project-specific documentation, technical skill resources, company handbooks, and external resources.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Getting Help',
+            order: 9,
+            contentType: 'prose',
+            guidance: 'Escalation steps when stuck: self-debug, search resources, ask onboarding buddy, ask team channel, ask broader engineering.',
+            required: true,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Team Culture & Expectations',
+            order: 10,
+            contentType: 'prose',
+            guidance: 'Work hours, code review expectations, development principles, and growth opportunities.',
+            required: false,
+            headingLevel: 2,
+        },
+    ],
+    linkTo: ['development-workflow.md', 'project-overview.md', 'architecture.md'],
+};
+//# sourceMappingURL=onboarding.js.map

package/dist/generators/shared/structures/documentation/onboarding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"onboarding.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/onboarding.ts"],"names":[],"mappings":";;;AAEa,QAAA,mBAAmB,GAAsB;IACpD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,YAAY;IAC1B,KAAK,EAAE,kBAAkB;IACzB,WAAW,EAAE,wGAAwG;IACrH,IAAI,EAAE,eAAe;IACrB,QAAQ,EAAE,YAAY;IACtB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,kBAAkB;YAC3B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,oEAAoE;YAC9E,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,WAAW;YACxB,QAAQ,EAAE,oHAAoH;YAC9H,cAAc,EAAE,oRAAoR;YACpS,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,kCAAkC;YAC3C,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,0GAA0G;YACpH,cAAc,EAAE,gOAAgO;YAChP,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,gCAAgC;YACzC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,yHAAyH;YACnI,cAAc,EAAE,mQAAmQ;YACnR,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,6BAA6B;YACtC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,qGAAqG;YAC/G,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,+BAA+B;YACxC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,oIAAoI;YAC9I,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,oBAAoB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,2EAA2E;YACrF,cAAc,EAAE,uOAAuO;YACvP,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,oBAAoB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,gHAAgH;YAC1H,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,6HAA6H;YACvI,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,6BAA6B;YACtC,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,yFAAyF;YACnG,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;KACF;IACD,MAAM,EAAE,CAAC,yBAAyB,EAAE,qBAAqB,EAAE,iBAAiB,CAAC;CAC9E,CAAC"}

package/dist/generators/shared/structures/documentation/projectOverview.d.ts

@@ -0,0 +1,3 @@
+import { ScaffoldStructure } from '../types';
+export declare const projectOverviewStructure: ScaffoldStructure;
+//# sourceMappingURL=projectOverview.d.ts.map

package/dist/generators/shared/structures/documentation/projectOverview.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"projectOverview.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/projectOverview.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,wBAAwB,EAAE,iBA8JtC,CAAC"}

package/dist/generators/shared/structures/documentation/projectOverview.js

@@ -0,0 +1,163 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.projectOverviewStructure = void 0;
+exports.projectOverviewStructure = {
+    fileType: 'doc',
+    documentName: 'project-overview',
+    title: 'Project Overview',
+    description: 'High-level overview of the project, its purpose, and key components',
+    tone: 'conversational',
+    audience: 'mixed',
+    sections: [
+        {
+            heading: 'Project Overview',
+            order: 1,
+            contentType: 'prose',
+            guidance: 'Summarize in 2-3 sentences what problem this project solves and who benefits from it. Focus on the value proposition.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `This project provides [describe main functionality]. It helps [target users] to [key benefit].
+
+The codebase is organized to support [main use case] with a focus on [key qualities like maintainability, performance, etc.].`,
+        },
+        {
+            heading: 'Codebase Reference',
+            order: 2,
+            contentType: 'prose',
+            guidance: 'Add a callout pointing to codebase-map.json for detailed symbol counts, architecture layers, and dependencies. Do NOT list all symbols inline.',
+            exampleContent: '> **Detailed Analysis**: For complete symbol counts, architecture layers, and dependency graphs, see [`codebase-map.json`](./codebase-map.json).',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `> **Detailed Analysis**: For complete symbol counts, architecture layers, and dependency graphs, see [\`codebase-map.json\`](./codebase-map.json).`,
+        },
+        {
+            heading: 'Quick Facts',
+            order: 3,
+            contentType: 'list',
+            guidance: 'List root directory path, primary languages (with file counts), and key entry points. Reference codebase-map.json for full analysis.',
+            exampleContent: '- Root: `/path/to/repo`\n- Languages: TypeScript (150 files), Python (20 files)\n- Entry: `src/index.ts`\n- Full analysis: [`codebase-map.json`](./codebase-map.json)',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `- **Root**: \`./\`
+- **Primary Language**: [Language] ([X] files)
+- **Entry Point**: \`src/index.ts\` or \`src/main.ts\`
+- **Full Analysis**: [\`codebase-map.json\`](./codebase-map.json)`,
+        },
+        {
+            heading: 'Entry Points',
+            order: 4,
+            contentType: 'list',
+            guidance: 'List main entry points with links (CLI, server, library exports). Use markdown links with line numbers.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `- **Main Entry**: \`src/index.ts\` - Primary module exports
+- **CLI**: \`src/cli.ts\` - Command-line interface (if applicable)
+- **Server**: \`src/server.ts\` - HTTP server entry (if applicable)`,
+        },
+        {
+            heading: 'Key Exports',
+            order: 5,
+            contentType: 'list',
+            guidance: 'Reference codebase-map.json for the complete list.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `See [\`codebase-map.json\`](./codebase-map.json) for the complete list of exported symbols.
+
+Key public APIs:
+- [List main exported classes/functions]`,
+        },
+        {
+            heading: 'File Structure & Code Organization',
+            order: 6,
+            contentType: 'list',
+            guidance: 'List top-level directories with brief descriptions of their purpose.',
+            exampleContent: '- `src/` — TypeScript source files and CLI entrypoints.\n- `tests/` — Automated tests and fixtures.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `- \`src/\` — Source code and main application logic
+- \`tests/\` or \`__tests__/\` — Test files and fixtures
+- \`dist/\` or \`build/\` — Compiled output (gitignored)
+- \`docs/\` — Documentation files
+- \`scripts/\` — Build and utility scripts`,
+        },
+        {
+            heading: 'Technology Stack Summary',
+            order: 7,
+            contentType: 'prose',
+            guidance: 'Outline primary runtimes, languages, and platforms in use. Note build tooling, linting, and formatting infrastructure.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `**Runtime**: Node.js
+
+**Language**: TypeScript/JavaScript
+
+**Build Tools**:
+- TypeScript compiler (tsc) or bundler (esbuild, webpack, etc.)
+- Package manager: npm/yarn/pnpm
+
+**Code Quality**:
+- Linting: ESLint
+- Formatting: Prettier
+- Type checking: TypeScript strict mode`,
+        },
+        {
+            heading: 'Core Framework Stack',
+            order: 8,
+            contentType: 'prose',
+            guidance: 'Document core frameworks per layer (backend, frontend, data, messaging). Mention architectural patterns enforced by these frameworks.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'UI & Interaction Libraries',
+            order: 9,
+            contentType: 'prose',
+            guidance: 'List UI kits, CLI interaction helpers, or design system dependencies. Note theming, accessibility, or localization considerations.',
+            required: false,
+            headingLevel: 2,
+        },
+        {
+            heading: 'Development Tools Overview',
+            order: 10,
+            contentType: 'prose',
+            guidance: 'Highlight essential CLIs, scripts, or developer environments. Link to Tooling guide for deeper setup.',
+            required: false,
+            headingLevel: 2,
+            defaultContent: `See [Tooling](./tooling.md) for detailed development environment setup.
+
+**Essential Commands**:
+- \`npm install\` — Install dependencies
+- \`npm run build\` — Build the project
+- \`npm run test\` — Run tests
+- \`npm run dev\` — Start development mode`,
+        },
+        {
+            heading: 'Getting Started Checklist',
+            order: 11,
+            contentType: 'checklist',
+            guidance: 'Provide numbered steps to get a new developer productive. Include install, run, and verify steps.',
+            exampleContent: '1. Install dependencies with `npm install`.\n2. Explore the CLI by running `npm run dev`.\n3. Review Development Workflow for day-to-day tasks.',
+            required: true,
+            headingLevel: 2,
+            defaultContent: `1. Clone the repository
+2. Install dependencies: \`npm install\`
+3. Copy environment template: \`cp .env.example .env\` (if applicable)
+4. Run tests to verify setup: \`npm run test\`
+5. Start development: \`npm run dev\`
+6. Review [Development Workflow](./development-workflow.md) for day-to-day tasks`,
+        },
+        {
+            heading: 'Next Steps',
+            order: 12,
+            contentType: 'prose',
+            guidance: 'Capture product positioning, key stakeholders, and links to external documentation or product specs.',
+            required: false,
+            headingLevel: 2,
+            defaultContent: `- Review [Architecture](./architecture.md) for system design details
+- See [Development Workflow](./development-workflow.md) for contribution guidelines
+- Check [Testing Strategy](./testing-strategy.md) for quality requirements`,
+        },
+    ],
+    linkTo: ['architecture.md', 'development-workflow.md', 'tooling.md', 'codebase-map.json'],
+};
+//# sourceMappingURL=projectOverview.js.map

package/dist/generators/shared/structures/documentation/projectOverview.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"projectOverview.js","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/projectOverview.ts"],"names":[],"mappings":";;;AAEa,QAAA,wBAAwB,GAAsB;IACzD,QAAQ,EAAE,KAAK;IACf,YAAY,EAAE,kBAAkB;IAChC,KAAK,EAAE,kBAAkB;IACzB,WAAW,EAAE,qEAAqE;IAClF,IAAI,EAAE,gBAAgB;IACtB,QAAQ,EAAE,OAAO;IACjB,QAAQ,EAAE;QACR;YACE,OAAO,EAAE,kBAAkB;YAC3B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,uHAAuH;YACjI,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;8HAEwG;SACzH;QACD;YACE,OAAO,EAAE,oBAAoB;YAC7B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,gJAAgJ;YAC1J,cAAc,EAAE,kJAAkJ;YAClK,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE,oJAAoJ;SACrK;QACD;YACE,OAAO,EAAE,aAAa;YACtB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,sIAAsI;YAChJ,cAAc,EAAE,uKAAuK;YACvL,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;kEAG4C;SAC7D;QACD;YACE,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,yGAAyG;YACnH,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;oEAE8C;SAC/D;QACD;YACE,OAAO,EAAE,aAAa;YACtB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,oDAAoD;YAC9D,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;yCAGmB;SACpC;QACD;YACE,OAAO,EAAE,oCAAoC;YAC7C,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,MAAM;YACnB,QAAQ,EAAE,sEAAsE;YAChF,cAAc,EAAE,qGAAqG;YACrH,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;2CAIqB;SACtC;QACD;YACE,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,wHAAwH;YAClI,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;;;;;;;;wCAWkB;SACnC;QACD;YACE,OAAO,EAAE,sBAAsB;YAC/B,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,uIAAuI;YACjJ,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,4BAA4B;YACrC,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,oIAAoI;YAC9I,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;SAChB;QACD;YACE,OAAO,EAAE,4BAA4B;YACrC,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,uGAAuG;YACjH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;;;2CAMqB;SACtC;QACD;YACE,OAAO,EAAE,2BAA2B;YACpC,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,WAAW;YACxB,QAAQ,EAAE,mGAAmG;YAC7G,cAAc,EAAE,iJAAiJ;YACjK,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;;;;iFAK2D;SAC5E;QACD;YACE,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,OAAO;YACpB,QAAQ,EAAE,sGAAsG;YAChH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,CAAC;YACf,cAAc,EAAE;;2EAEqD;SACtE;KACF;IACD,MAAM,EAAE,CAAC,iBAAiB,EAAE,yBAAyB,EAAE,YAAY,EAAE,mBAAmB,CAAC;CAC1F,CAAC"}

package/dist/generators/shared/structures/documentation/security.d.ts

@@ -0,0 +1,3 @@
+import { ScaffoldStructure } from '../types';
+export declare const securityStructure: ScaffoldStructure;
+//# sourceMappingURL=security.d.ts.map

package/dist/generators/shared/structures/documentation/security.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"security.d.ts","sourceRoot":"","sources":["../../../../../src/generators/shared/structures/documentation/security.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,iBAAiB,EAAE,iBA+F/B,CAAC"}