@ggailabs/cli-context 0.5.6 → 1.0.1
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.
Potentially problematic release.
This version of @ggailabs/cli-context might be problematic. Click here for more details.
- package/README.md +25 -181
- package/dist/.context/docs/GENESIS_SYSTEM_PROMPT.md +62 -0
- package/dist/.context/eng/agents/architect.md +15 -0
- package/dist/.context/eng/agents/backend_typescript.md +1000 -0
- package/dist/.context/eng/agents/bug_hunter.md +49 -0
- package/dist/.context/eng/agents/code_reviewer.md +313 -0
- package/dist/.context/eng/agents/devops_specialist.md +718 -0
- package/dist/.context/eng/agents/frontend_specialist.md +1027 -0
- package/dist/.context/eng/agents/qa_specialist.md +1234 -0
- package/dist/.context/eng/agents/security_reviewer.md +382 -0
- package/dist/.context/eng/agents/ui_specialist.md +16 -0
- package/dist/.context/eng/docs/AGENT_HANDOFF_PROMPT.md +44 -0
- package/dist/.context/eng/docs/GENESIS_DESIGN_SYSTEM.md +15 -0
- package/dist/.context/eng/docs/GG_METHODOLOGY.md +48 -0
- package/dist/.context/eng/docs/OPERATIONS_LOG.md +30 -0
- package/dist/.context/eng/docs/PROJECT_MAP.md +35 -0
- package/dist/.context/eng/docs/standards/devops.md +0 -0
- package/dist/.context/eng/docs/standards/frontend.md +0 -0
- package/dist/.context/eng/docs/standards/typescript.md +12 -0
- package/dist/.context/eng/skills/agent_logging.md +18 -0
- package/dist/.context/eng/skills/brainstorming.md +227 -0
- package/dist/.context/eng/skills/exploring_codebase.md +1217 -0
- package/dist/.context/eng/skills/patterns/compliance_check.md +246 -0
- package/dist/.context/eng/skills/patterns/coverage_table.md +401 -0
- package/dist/.context/eng/skills/patterns/exit_criteria.md +31 -0
- package/dist/.context/eng/skills/patterns/failure_recovery.md +74 -0
- package/dist/.context/eng/skills/patterns/quality_gate.md +295 -0
- package/dist/.context/eng/skills/patterns/standards_workflow.md +391 -0
- package/dist/.context/eng/skills/patterns/state_tracking.md +30 -0
- package/dist/.context/eng/skills/patterns/task_tracking.md +38 -0
- package/dist/.context/eng/skills/previce.md +45 -0
- package/dist/.context/eng/skills/tdd.md +421 -0
- package/dist/.context/eng/skills/writing_plans.md +105 -0
- package/dist/.context/plans/.gitkeep +0 -0
- package/dist/.context/pt-br/agents/architect.md +69 -0
- package/dist/.context/pt-br/agents/backend_typescript.md +1000 -0
- package/dist/.context/pt-br/agents/bug_hunter.md +49 -0
- package/dist/.context/pt-br/agents/code_reviewer.md +313 -0
- package/dist/.context/pt-br/agents/devops_specialist.md +718 -0
- package/dist/.context/pt-br/agents/frontend_specialist.md +1027 -0
- package/dist/.context/pt-br/agents/qa_specialist.md +1234 -0
- package/dist/.context/pt-br/agents/security_reviewer.md +382 -0
- package/dist/.context/pt-br/agents/ui_specialist.md +55 -0
- package/dist/.context/pt-br/docs/AGENT_HANDOFF_PROMPT.md +44 -0
- package/dist/.context/pt-br/docs/GENESIS_DESIGN_SYSTEM.md +88 -0
- package/dist/.context/pt-br/docs/GG_METHODOLOGY.md +48 -0
- package/dist/.context/pt-br/docs/OPERATIONS_LOG.md +30 -0
- package/dist/.context/pt-br/docs/PROJECT_MAP.md +37 -0
- package/dist/.context/pt-br/docs/standards/devops.md +707 -0
- package/dist/.context/pt-br/docs/standards/frontend.md +748 -0
- package/dist/.context/pt-br/docs/standards/typescript.md +1150 -0
- package/dist/.context/pt-br/skills/agent_logging.md +36 -0
- package/dist/.context/pt-br/skills/brainstorming.md +227 -0
- package/dist/.context/pt-br/skills/exploring_codebase.md +1217 -0
- package/dist/.context/pt-br/skills/patterns/compliance_check.md +246 -0
- package/dist/.context/pt-br/skills/patterns/coverage_table.md +401 -0
- package/dist/.context/pt-br/skills/patterns/exit_criteria.md +31 -0
- package/dist/.context/pt-br/skills/patterns/failure_recovery.md +74 -0
- package/dist/.context/pt-br/skills/patterns/quality_gate.md +295 -0
- package/dist/.context/pt-br/skills/patterns/standards_workflow.md +391 -0
- package/dist/.context/pt-br/skills/patterns/state_tracking.md +30 -0
- package/dist/.context/pt-br/skills/patterns/task_tracking.md +38 -0
- package/dist/.context/pt-br/skills/previce.md +45 -0
- package/dist/.context/pt-br/skills/tdd.md +421 -0
- package/dist/.context/pt-br/skills/writing_plans.md +105 -0
- package/dist/.context/workflow/.gitkeep +0 -0
- package/dist/commands/init.js +140 -0
- package/dist/commands/monitor.js +34 -0
- package/dist/index.js +20 -568
- package/dist/services/monitor-service.js +340 -0
- package/dist/services/scaffolder.js +164 -0
- package/package.json +16 -58
- package/LICENSE +0 -21
- package/dist/generators/agents/agentConfig.d.ts +0 -4
- package/dist/generators/agents/agentConfig.d.ts.map +0 -1
- package/dist/generators/agents/agentConfig.js +0 -180
- package/dist/generators/agents/agentConfig.js.map +0 -1
- package/dist/generators/agents/agentGenerator.d.ts +0 -9
- package/dist/generators/agents/agentGenerator.d.ts.map +0 -1
- package/dist/generators/agents/agentGenerator.js +0 -97
- package/dist/generators/agents/agentGenerator.js.map +0 -1
- package/dist/generators/agents/agentTypes.d.ts +0 -4
- package/dist/generators/agents/agentTypes.d.ts.map +0 -1
- package/dist/generators/agents/agentTypes.js +0 -25
- package/dist/generators/agents/agentTypes.js.map +0 -1
- package/dist/generators/agents/index.d.ts +0 -4
- package/dist/generators/agents/index.d.ts.map +0 -1
- package/dist/generators/agents/index.js +0 -12
- package/dist/generators/agents/index.js.map +0 -1
- package/dist/generators/agents/templates/index.d.ts +0 -4
- package/dist/generators/agents/templates/index.d.ts.map +0 -1
- package/dist/generators/agents/templates/index.js +0 -8
- package/dist/generators/agents/templates/index.js.map +0 -1
- package/dist/generators/agents/templates/indexTemplate.d.ts +0 -3
- package/dist/generators/agents/templates/indexTemplate.d.ts.map +0 -1
- package/dist/generators/agents/templates/indexTemplate.js +0 -36
- package/dist/generators/agents/templates/indexTemplate.js.map +0 -1
- package/dist/generators/agents/templates/playbookTemplate.d.ts +0 -4
- package/dist/generators/agents/templates/playbookTemplate.d.ts.map +0 -1
- package/dist/generators/agents/templates/playbookTemplate.js +0 -99
- package/dist/generators/agents/templates/playbookTemplate.js.map +0 -1
- package/dist/generators/agents/templates/types.d.ts +0 -14
- package/dist/generators/agents/templates/types.d.ts.map +0 -1
- package/dist/generators/agents/templates/types.js +0 -3
- package/dist/generators/agents/templates/types.js.map +0 -1
- package/dist/generators/documentation/documentationGenerator.d.ts +0 -15
- package/dist/generators/documentation/documentationGenerator.d.ts.map +0 -1
- package/dist/generators/documentation/documentationGenerator.js +0 -188
- package/dist/generators/documentation/documentationGenerator.js.map +0 -1
- package/dist/generators/documentation/guideRegistry.d.ts +0 -6
- package/dist/generators/documentation/guideRegistry.d.ts.map +0 -1
- package/dist/generators/documentation/guideRegistry.js +0 -82
- package/dist/generators/documentation/guideRegistry.js.map +0 -1
- package/dist/generators/documentation/index.d.ts +0 -2
- package/dist/generators/documentation/index.d.ts.map +0 -1
- package/dist/generators/documentation/index.js +0 -6
- package/dist/generators/documentation/index.js.map +0 -1
- package/dist/generators/documentation/templates/apiReferenceTemplate.d.ts +0 -2
- package/dist/generators/documentation/templates/apiReferenceTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/apiReferenceTemplate.js +0 -490
- package/dist/generators/documentation/templates/apiReferenceTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/architectureTemplate.d.ts +0 -3
- package/dist/generators/documentation/templates/architectureTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/architectureTemplate.js +0 -66
- package/dist/generators/documentation/templates/architectureTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/common.d.ts +0 -7
- package/dist/generators/documentation/templates/common.d.ts.map +0 -1
- package/dist/generators/documentation/templates/common.js +0 -58
- package/dist/generators/documentation/templates/common.js.map +0 -1
- package/dist/generators/documentation/templates/dataFlowTemplate.d.ts +0 -3
- package/dist/generators/documentation/templates/dataFlowTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/dataFlowTemplate.js +0 -40
- package/dist/generators/documentation/templates/dataFlowTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/developmentWorkflowTemplate.d.ts +0 -2
- package/dist/generators/documentation/templates/developmentWorkflowTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/developmentWorkflowTemplate.js +0 -44
- package/dist/generators/documentation/templates/developmentWorkflowTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/glossaryTemplate.d.ts +0 -3
- package/dist/generators/documentation/templates/glossaryTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/glossaryTemplate.js +0 -41
- package/dist/generators/documentation/templates/glossaryTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/index.d.ts +0 -15
- package/dist/generators/documentation/templates/index.d.ts.map +0 -1
- package/dist/generators/documentation/templates/index.js +0 -30
- package/dist/generators/documentation/templates/index.js.map +0 -1
- package/dist/generators/documentation/templates/indexTemplate.d.ts +0 -3
- package/dist/generators/documentation/templates/indexTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/indexTemplate.js +0 -42
- package/dist/generators/documentation/templates/indexTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/migrationTemplate.d.ts +0 -2
- package/dist/generators/documentation/templates/migrationTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/migrationTemplate.js +0 -422
- package/dist/generators/documentation/templates/migrationTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/onboardingTemplate.d.ts +0 -2
- package/dist/generators/documentation/templates/onboardingTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/onboardingTemplate.js +0 -431
- package/dist/generators/documentation/templates/onboardingTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/projectOverviewTemplate.d.ts +0 -3
- package/dist/generators/documentation/templates/projectOverviewTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/projectOverviewTemplate.js +0 -65
- package/dist/generators/documentation/templates/projectOverviewTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/securityTemplate.d.ts +0 -2
- package/dist/generators/documentation/templates/securityTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/securityTemplate.js +0 -39
- package/dist/generators/documentation/templates/securityTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/testingTemplate.d.ts +0 -2
- package/dist/generators/documentation/templates/testingTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/testingTemplate.js +0 -45
- package/dist/generators/documentation/templates/testingTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/toolingTemplate.d.ts +0 -2
- package/dist/generators/documentation/templates/toolingTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/toolingTemplate.js +0 -42
- package/dist/generators/documentation/templates/toolingTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/troubleshootingTemplate.d.ts +0 -2
- package/dist/generators/documentation/templates/troubleshootingTemplate.d.ts.map +0 -1
- package/dist/generators/documentation/templates/troubleshootingTemplate.js +0 -292
- package/dist/generators/documentation/templates/troubleshootingTemplate.js.map +0 -1
- package/dist/generators/documentation/templates/types.d.ts +0 -23
- package/dist/generators/documentation/templates/types.d.ts.map +0 -1
- package/dist/generators/documentation/templates/types.js +0 -3
- package/dist/generators/documentation/templates/types.js.map +0 -1
- package/dist/generators/plans/index.d.ts +0 -2
- package/dist/generators/plans/index.d.ts.map +0 -1
- package/dist/generators/plans/index.js +0 -6
- package/dist/generators/plans/index.js.map +0 -1
- package/dist/generators/plans/planGenerator.d.ts +0 -22
- package/dist/generators/plans/planGenerator.d.ts.map +0 -1
- package/dist/generators/plans/planGenerator.js +0 -109
- package/dist/generators/plans/planGenerator.js.map +0 -1
- package/dist/generators/plans/templates/indexTemplate.d.ts +0 -3
- package/dist/generators/plans/templates/indexTemplate.d.ts.map +0 -1
- package/dist/generators/plans/templates/indexTemplate.js +0 -37
- package/dist/generators/plans/templates/indexTemplate.js.map +0 -1
- package/dist/generators/plans/templates/planTemplate.d.ts +0 -3
- package/dist/generators/plans/templates/planTemplate.d.ts.map +0 -1
- package/dist/generators/plans/templates/planTemplate.js +0 -166
- package/dist/generators/plans/templates/planTemplate.js.map +0 -1
- package/dist/generators/plans/templates/types.d.ts +0 -19
- package/dist/generators/plans/templates/types.d.ts.map +0 -1
- package/dist/generators/plans/templates/types.js +0 -3
- package/dist/generators/plans/templates/types.js.map +0 -1
- package/dist/generators/shared/contextGenerator.d.ts +0 -7
- package/dist/generators/shared/contextGenerator.d.ts.map +0 -1
- package/dist/generators/shared/contextGenerator.js +0 -13
- package/dist/generators/shared/contextGenerator.js.map +0 -1
- package/dist/generators/shared/directoryTemplateHelpers.d.ts +0 -2
- package/dist/generators/shared/directoryTemplateHelpers.d.ts.map +0 -1
- package/dist/generators/shared/directoryTemplateHelpers.js +0 -12
- package/dist/generators/shared/directoryTemplateHelpers.js.map +0 -1
- package/dist/generators/shared/generatorUtils.d.ts +0 -16
- package/dist/generators/shared/generatorUtils.d.ts.map +0 -1
- package/dist/generators/shared/generatorUtils.js +0 -119
- package/dist/generators/shared/generatorUtils.js.map +0 -1
- package/dist/generators/shared/index.d.ts +0 -4
- package/dist/generators/shared/index.d.ts.map +0 -1
- package/dist/generators/shared/index.js +0 -10
- package/dist/generators/shared/index.js.map +0 -1
- package/dist/index.d.ts +0 -9
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/prompts/defaults.d.ts +0 -3
- package/dist/prompts/defaults.d.ts.map +0 -1
- package/dist/prompts/defaults.js +0 -95
- package/dist/prompts/defaults.js.map +0 -1
- package/dist/services/baseLLMClient.d.ts +0 -12
- package/dist/services/baseLLMClient.d.ts.map +0 -1
- package/dist/services/baseLLMClient.js +0 -80
- package/dist/services/baseLLMClient.js.map +0 -1
- package/dist/services/fill/fillService.d.ts +0 -46
- package/dist/services/fill/fillService.d.ts.map +0 -1
- package/dist/services/fill/fillService.js +0 -254
- package/dist/services/fill/fillService.js.map +0 -1
- package/dist/services/init/initService.d.ts +0 -37
- package/dist/services/init/initService.d.ts.map +0 -1
- package/dist/services/init/initService.js +0 -167
- package/dist/services/init/initService.js.map +0 -1
- package/dist/services/llmClientFactory.d.ts +0 -8
- package/dist/services/llmClientFactory.d.ts.map +0 -1
- package/dist/services/llmClientFactory.js +0 -23
- package/dist/services/llmClientFactory.js.map +0 -1
- package/dist/services/openRouterClient.d.ts +0 -9
- package/dist/services/openRouterClient.d.ts.map +0 -1
- package/dist/services/openRouterClient.js +0 -49
- package/dist/services/openRouterClient.js.map +0 -1
- package/dist/services/plan/planService.d.ts +0 -57
- package/dist/services/plan/planService.d.ts.map +0 -1
- package/dist/services/plan/planService.js +0 -334
- package/dist/services/plan/planService.js.map +0 -1
- package/dist/services/shared/llmConfig.d.ts +0 -22
- package/dist/services/shared/llmConfig.d.ts.map +0 -1
- package/dist/services/shared/llmConfig.js +0 -38
- package/dist/services/shared/llmConfig.js.map +0 -1
- package/dist/types.d.ts +0 -65
- package/dist/types.d.ts.map +0 -1
- package/dist/types.js +0 -3
- package/dist/types.js.map +0 -1
- package/dist/utils/cliUI.d.ts +0 -27
- package/dist/utils/cliUI.d.ts.map +0 -1
- package/dist/utils/cliUI.js +0 -252
- package/dist/utils/cliUI.js.map +0 -1
- package/dist/utils/fileMapper.d.ts +0 -11
- package/dist/utils/fileMapper.d.ts.map +0 -1
- package/dist/utils/fileMapper.js +0 -146
- package/dist/utils/fileMapper.js.map +0 -1
- package/dist/utils/gitService.d.ts +0 -50
- package/dist/utils/gitService.d.ts.map +0 -1
- package/dist/utils/gitService.js +0 -470
- package/dist/utils/gitService.js.map +0 -1
- package/dist/utils/i18n.d.ts +0 -171
- package/dist/utils/i18n.d.ts.map +0 -1
- package/dist/utils/i18n.js +0 -381
- package/dist/utils/i18n.js.map +0 -1
- package/dist/utils/promptLoader.d.ts +0 -12
- package/dist/utils/promptLoader.d.ts.map +0 -1
- package/dist/utils/promptLoader.js +0 -81
- package/dist/utils/promptLoader.js.map +0 -1
- package/dist/utils/versionChecker.d.ts +0 -15
- package/dist/utils/versionChecker.d.ts.map +0 -1
- package/dist/utils/versionChecker.js +0 -49
- package/dist/utils/versionChecker.js.map +0 -1
- package/prompts/update_plan_prompt.md +0 -41
- package/prompts/update_scaffold_prompt.md +0 -47
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.renderDataFlow = renderDataFlow;
|
|
4
|
-
const common_1 = require("./common");
|
|
5
|
-
function renderDataFlow(context) {
|
|
6
|
-
return `<!-- agent-update:start:data-flow -->
|
|
7
|
-
# Data Flow & Integrations
|
|
8
|
-
|
|
9
|
-
Explain how data enters, moves through, and exits the system, including interactions with external services.
|
|
10
|
-
|
|
11
|
-
## High-level Flow
|
|
12
|
-
- Summarize the primary pipeline from input to output. Reference diagrams or embed Mermaid definitions when available.
|
|
13
|
-
|
|
14
|
-
## Internal Movement
|
|
15
|
-
- Describe how modules within ${(0, common_1.formatInlineDirectoryList)(context.topLevelDirectories)} collaborate (queues, events, RPC calls, shared databases).
|
|
16
|
-
|
|
17
|
-
## External Integrations
|
|
18
|
-
- <!-- agent-fill:integration -->**Integration** — Purpose, authentication, payload shapes, retry strategy.<!-- /agent-fill -->
|
|
19
|
-
|
|
20
|
-
## Observability & Failure Modes
|
|
21
|
-
- Metrics, traces, or logs that monitor the flow.
|
|
22
|
-
- Backoff, dead-letter, or compensating actions when downstream systems fail.
|
|
23
|
-
|
|
24
|
-
<!-- agent-readonly:guidance -->
|
|
25
|
-
## AI Update Checklist
|
|
26
|
-
1. Validate flows against the latest integration contracts or diagrams.
|
|
27
|
-
2. Update authentication, scopes, or rate limits when they change.
|
|
28
|
-
3. Capture recent incidents or lessons learned that influenced reliability.
|
|
29
|
-
4. Link to runbooks or dashboards used during triage.
|
|
30
|
-
|
|
31
|
-
<!-- agent-readonly:sources -->
|
|
32
|
-
## Acceptable Sources
|
|
33
|
-
- Architecture diagrams, ADRs, integration playbooks.
|
|
34
|
-
- API specs, queue/topic definitions, infrastructure code.
|
|
35
|
-
- Postmortems or incident reviews impacting data movement.
|
|
36
|
-
|
|
37
|
-
<!-- agent-update:end -->
|
|
38
|
-
`;
|
|
39
|
-
}
|
|
40
|
-
//# sourceMappingURL=dataFlowTemplate.js.map
|
|
@@ -1 +0,0 @@
|
|
|
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 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"developmentWorkflowTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/developmentWorkflowTemplate.ts"],"names":[],"mappings":"AAAA,wBAAgB,yBAAyB,IAAI,MAAM,CAuClD"}
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.renderDevelopmentWorkflow = renderDevelopmentWorkflow;
|
|
4
|
-
function renderDevelopmentWorkflow() {
|
|
5
|
-
return `<!-- agent-update:start:development-workflow -->
|
|
6
|
-
# Development Workflow
|
|
7
|
-
|
|
8
|
-
Outline the day-to-day engineering process for this repository.
|
|
9
|
-
|
|
10
|
-
## Branching & Releases
|
|
11
|
-
- Describe the branching model (e.g., trunk-based, Git Flow).
|
|
12
|
-
- Note release cadence and tagging conventions.
|
|
13
|
-
|
|
14
|
-
## Local Development
|
|
15
|
-
- Commands to install dependencies: \`npm install\`
|
|
16
|
-
- Run the CLI locally: \`npm run dev\`
|
|
17
|
-
- Build for distribution: \`npm run build\`
|
|
18
|
-
|
|
19
|
-
## Code Review Expectations
|
|
20
|
-
- Summarize review checklists and required approvals.
|
|
21
|
-
- Reference [AGENTS.md](../../AGENTS.md) for agent collaboration tips.
|
|
22
|
-
|
|
23
|
-
## Onboarding Tasks
|
|
24
|
-
- Point newcomers to first issues or starter tickets.
|
|
25
|
-
- Link to internal runbooks or dashboards.
|
|
26
|
-
|
|
27
|
-
<!-- agent-readonly:guidance -->
|
|
28
|
-
## AI Update Checklist
|
|
29
|
-
1. Confirm branching/release steps with CI configuration and recent tags.
|
|
30
|
-
2. Verify local commands against \`package.json\`; ensure flags and scripts still exist.
|
|
31
|
-
3. Capture review requirements (approvers, checks) from contributing docs or repository settings.
|
|
32
|
-
4. Refresh onboarding links (boards, dashboards) to their latest URLs.
|
|
33
|
-
5. Highlight any manual steps that should become automation follow-ups.
|
|
34
|
-
|
|
35
|
-
<!-- agent-readonly:sources -->
|
|
36
|
-
## Acceptable Sources
|
|
37
|
-
- CONTRIBUTING guidelines and \`AGENTS.md\`.
|
|
38
|
-
- Build pipelines, branch protection rules, or release scripts.
|
|
39
|
-
- Issue tracker boards used for onboarding or triage.
|
|
40
|
-
|
|
41
|
-
<!-- agent-update:end -->
|
|
42
|
-
`;
|
|
43
|
-
}
|
|
44
|
-
//# sourceMappingURL=developmentWorkflowTemplate.js.map
|
|
@@ -1 +0,0 @@
|
|
|
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 +0,0 @@
|
|
|
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,41 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.renderGlossary = renderGlossary;
|
|
4
|
-
function renderGlossary(_context) {
|
|
5
|
-
return `
|
|
6
|
-
<!-- agent-update:start:glossary -->
|
|
7
|
-
# Glossary & Domain Concepts
|
|
8
|
-
|
|
9
|
-
List project-specific terminology, acronyms, domain entities, and user personas.
|
|
10
|
-
|
|
11
|
-
## Core Terms
|
|
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 -->
|
|
14
|
-
|
|
15
|
-
## Acronyms & Abbreviations
|
|
16
|
-
- <!-- agent-fill:acronym -->**ABC** — Expanded form; why we use it; associated services or APIs.<!-- /agent-fill -->
|
|
17
|
-
|
|
18
|
-
## Personas / Actors
|
|
19
|
-
- <!-- agent-fill:persona -->**Persona Name** — Goals, key workflows, pain points addressed by the system.<!-- /agent-fill -->
|
|
20
|
-
|
|
21
|
-
## Domain Rules & Invariants
|
|
22
|
-
- Capture business rules, validation constraints, or compliance requirements that the code enforces.
|
|
23
|
-
- Note any region, localization, or regulatory nuances.
|
|
24
|
-
|
|
25
|
-
<!-- agent-readonly:guidance -->
|
|
26
|
-
## AI Update Checklist
|
|
27
|
-
1. Harvest terminology from recent PRs, issues, and discussions.
|
|
28
|
-
2. Confirm definitions with product or domain experts when uncertain.
|
|
29
|
-
3. Link terms to relevant docs or modules for deeper context.
|
|
30
|
-
4. Remove or archive outdated concepts; flag unknown terms for follow-up.
|
|
31
|
-
|
|
32
|
-
<!-- agent-readonly:sources -->
|
|
33
|
-
## Acceptable Sources
|
|
34
|
-
- Product requirement docs, RFCs, user research, or support tickets.
|
|
35
|
-
- Service contracts, API schemas, data dictionaries.
|
|
36
|
-
- Conversations with domain experts (summarize outcomes if applicable).
|
|
37
|
-
|
|
38
|
-
<!-- agent-update:end -->
|
|
39
|
-
`;
|
|
40
|
-
}
|
|
41
|
-
//# sourceMappingURL=glossaryTemplate.js.map
|
|
@@ -1 +0,0 @@
|
|
|
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"}
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
export { renderIndex } from './indexTemplate';
|
|
2
|
-
export { renderProjectOverview } from './projectOverviewTemplate';
|
|
3
|
-
export { renderArchitectureNotes } from './architectureTemplate';
|
|
4
|
-
export { renderDevelopmentWorkflow } from './developmentWorkflowTemplate';
|
|
5
|
-
export { renderTestingStrategy } from './testingTemplate';
|
|
6
|
-
export { renderGlossary } from './glossaryTemplate';
|
|
7
|
-
export { renderDataFlow } from './dataFlowTemplate';
|
|
8
|
-
export { renderSecurity } from './securityTemplate';
|
|
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';
|
|
14
|
-
export type { DocumentationTemplateContext, GuideMeta, DirectoryStat } from './types';
|
|
15
|
-
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +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,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,30 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
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
|
-
var indexTemplate_1 = require("./indexTemplate");
|
|
5
|
-
Object.defineProperty(exports, "renderIndex", { enumerable: true, get: function () { return indexTemplate_1.renderIndex; } });
|
|
6
|
-
var projectOverviewTemplate_1 = require("./projectOverviewTemplate");
|
|
7
|
-
Object.defineProperty(exports, "renderProjectOverview", { enumerable: true, get: function () { return projectOverviewTemplate_1.renderProjectOverview; } });
|
|
8
|
-
var architectureTemplate_1 = require("./architectureTemplate");
|
|
9
|
-
Object.defineProperty(exports, "renderArchitectureNotes", { enumerable: true, get: function () { return architectureTemplate_1.renderArchitectureNotes; } });
|
|
10
|
-
var developmentWorkflowTemplate_1 = require("./developmentWorkflowTemplate");
|
|
11
|
-
Object.defineProperty(exports, "renderDevelopmentWorkflow", { enumerable: true, get: function () { return developmentWorkflowTemplate_1.renderDevelopmentWorkflow; } });
|
|
12
|
-
var testingTemplate_1 = require("./testingTemplate");
|
|
13
|
-
Object.defineProperty(exports, "renderTestingStrategy", { enumerable: true, get: function () { return testingTemplate_1.renderTestingStrategy; } });
|
|
14
|
-
var glossaryTemplate_1 = require("./glossaryTemplate");
|
|
15
|
-
Object.defineProperty(exports, "renderGlossary", { enumerable: true, get: function () { return glossaryTemplate_1.renderGlossary; } });
|
|
16
|
-
var dataFlowTemplate_1 = require("./dataFlowTemplate");
|
|
17
|
-
Object.defineProperty(exports, "renderDataFlow", { enumerable: true, get: function () { return dataFlowTemplate_1.renderDataFlow; } });
|
|
18
|
-
var securityTemplate_1 = require("./securityTemplate");
|
|
19
|
-
Object.defineProperty(exports, "renderSecurity", { enumerable: true, get: function () { return securityTemplate_1.renderSecurity; } });
|
|
20
|
-
var toolingTemplate_1 = require("./toolingTemplate");
|
|
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; } });
|
|
30
|
-
//# sourceMappingURL=index.js.map
|
|
@@ -1 +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;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 +0,0 @@
|
|
|
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,42 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.renderIndex = renderIndex;
|
|
4
|
-
const common_1 = require("./common");
|
|
5
|
-
function renderIndex(context) {
|
|
6
|
-
const directoryList = (0, common_1.formatDirectoryList)(context, false);
|
|
7
|
-
const documentMap = (0, common_1.buildDocumentMapTable)(context.guides);
|
|
8
|
-
const navigationList = context.guides
|
|
9
|
-
.map(guide => `- [${guide.title}](./${guide.file})`)
|
|
10
|
-
.join('\n') || '- *No guides selected.*';
|
|
11
|
-
return `
|
|
12
|
-
<!-- agent-update:start:docs-index -->
|
|
13
|
-
# Documentation Index
|
|
14
|
-
|
|
15
|
-
Welcome to the repository knowledge base. Start with the project overview, then dive into specific guides as needed.
|
|
16
|
-
|
|
17
|
-
## Core Guides
|
|
18
|
-
${navigationList}
|
|
19
|
-
|
|
20
|
-
## Repository Snapshot
|
|
21
|
-
${directoryList || '*Top-level directories will appear here once the repository contains subfolders.*'}
|
|
22
|
-
|
|
23
|
-
## Document Map
|
|
24
|
-
${documentMap}
|
|
25
|
-
|
|
26
|
-
<!-- agent-readonly:guidance -->
|
|
27
|
-
## AI Update Checklist
|
|
28
|
-
1. Gather context with \`git status -sb\` plus the latest commits touching \`docs/\` or \`agents/\`.
|
|
29
|
-
2. Compare the current directory tree against the table above; add or retire rows accordingly.
|
|
30
|
-
3. Update cross-links if guides moved or were renamed; keep anchor text concise.
|
|
31
|
-
4. Record sources consulted inside the commit or PR description for traceability.
|
|
32
|
-
|
|
33
|
-
<!-- agent-readonly:sources -->
|
|
34
|
-
## Acceptable Sources
|
|
35
|
-
- Repository tree and \`package.json\` scripts for canonical command names.
|
|
36
|
-
- Maintainer-approved issues, RFCs, or product briefs referenced in the repo.
|
|
37
|
-
- Release notes or changelog entries that announce documentation changes.
|
|
38
|
-
|
|
39
|
-
<!-- agent-update:end -->
|
|
40
|
-
`;
|
|
41
|
-
}
|
|
42
|
-
//# sourceMappingURL=indexTemplate.js.map
|
|
@@ -1 +0,0 @@
|
|
|
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"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"migrationTemplate.d.ts","sourceRoot":"","sources":["../../../../src/generators/documentation/templates/migrationTemplate.ts"],"names":[],"mappings":"AACA,wBAAgB,eAAe,IAAI,MAAM,CAkaxC"}
|