create-universal-ai-context 2.5.0 → 2.6.0-final
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -21
- package/README.md +331 -294
- package/bin/create-ai-context.js +1507 -775
- package/lib/adapters/aider.js +131 -131
- package/lib/adapters/antigravity.js +205 -205
- package/lib/adapters/claude.js +397 -397
- package/lib/adapters/cline.js +125 -125
- package/lib/adapters/continue.js +138 -138
- package/lib/adapters/copilot.js +131 -131
- package/lib/adapters/index.js +78 -78
- package/lib/adapters/windsurf.js +138 -138
- package/lib/ai-context-generator.js +234 -234
- package/lib/ai-orchestrator.js +432 -432
- package/lib/call-tracer.js +444 -444
- package/lib/content-preservation.js +243 -243
- package/lib/cross-tool-sync/file-watcher.js +274 -274
- package/lib/cross-tool-sync/index.js +41 -40
- package/lib/cross-tool-sync/sync-manager.js +540 -512
- package/lib/cross-tool-sync/sync-service.js +297 -297
- package/lib/detector.js +726 -726
- package/lib/doc-discovery.js +741 -741
- package/lib/drift-checker.js +920 -920
- package/lib/environment-detector.js +239 -239
- package/lib/index.js +399 -399
- package/lib/install-hooks.js +82 -82
- package/lib/installer.js +419 -419
- package/lib/migrate.js +328 -328
- package/lib/placeholder.js +632 -632
- package/lib/prompts.js +341 -341
- package/lib/smart-merge.js +540 -540
- package/lib/spinner.js +60 -60
- package/lib/static-analyzer.js +729 -729
- package/lib/template-coordination.js +148 -148
- package/lib/template-populator.js +843 -843
- package/lib/template-renderer.js +392 -392
- package/lib/utils/fs-wrapper.js +79 -79
- package/lib/utils/path-utils.js +60 -60
- package/lib/validate.js +155 -155
- package/package.json +1 -1
- package/templates/AI_CONTEXT.md.template +245 -245
- package/templates/base/README.md +260 -257
- package/templates/base/RPI_WORKFLOW_PLAN.md +325 -320
- package/templates/base/agents/api-developer.md +76 -76
- package/templates/base/agents/context-engineer.md +525 -525
- package/templates/base/agents/core-architect.md +76 -76
- package/templates/base/agents/database-ops.md +76 -76
- package/templates/base/agents/deployment-ops.md +76 -76
- package/templates/base/agents/integration-hub.md +76 -76
- package/templates/base/analytics/README.md +114 -114
- package/templates/base/automation/config.json +58 -58
- package/templates/base/automation/generators/code-mapper.js +308 -308
- package/templates/base/automation/generators/index-builder.js +321 -321
- package/templates/base/automation/hooks/post-commit.sh +83 -83
- package/templates/base/automation/hooks/pre-commit.sh +103 -103
- package/templates/base/ci-templates/README.md +108 -108
- package/templates/base/ci-templates/github-actions/context-check.yml +144 -144
- package/templates/base/ci-templates/github-actions/validate-docs.yml +105 -105
- package/templates/base/commands/analytics.md +238 -238
- package/templates/base/commands/auto-sync.md +172 -172
- package/templates/base/commands/collab.md +194 -194
- package/templates/base/commands/context-optimize.md +226 -0
- package/templates/base/commands/help.md +485 -450
- package/templates/base/commands/rpi-implement.md +164 -115
- package/templates/base/commands/rpi-plan.md +147 -93
- package/templates/base/commands/rpi-research.md +145 -88
- package/templates/base/commands/session-resume.md +144 -144
- package/templates/base/commands/session-save.md +112 -112
- package/templates/base/commands/validate-all.md +77 -77
- package/templates/base/commands/verify-docs-current.md +86 -86
- package/templates/base/config/base.json +57 -57
- package/templates/base/config/environments/development.json +13 -13
- package/templates/base/config/environments/production.json +17 -17
- package/templates/base/config/environments/staging.json +13 -13
- package/templates/base/config/local.json.example +21 -21
- package/templates/base/context/.meta/generated-at.json +18 -18
- package/templates/base/context/ARCHITECTURE_SNAPSHOT.md +156 -156
- package/templates/base/context/CODE_TO_WORKFLOW_MAP.md +94 -94
- package/templates/base/context/FILE_OWNERSHIP.md +57 -57
- package/templates/base/context/INTEGRATION_POINTS.md +92 -92
- package/templates/base/context/KNOWN_GOTCHAS.md +195 -195
- package/templates/base/context/TESTING_MAP.md +95 -95
- package/templates/base/context/WORKFLOW_INDEX.md +129 -129
- package/templates/base/context/workflows/WORKFLOW_TEMPLATE.md +294 -294
- package/templates/base/indexes/agents/CAPABILITY_MATRIX.md +255 -255
- package/templates/base/indexes/agents/CATEGORY_INDEX.md +44 -44
- package/templates/base/indexes/code/CATEGORY_INDEX.md +38 -38
- package/templates/base/indexes/routing/CATEGORY_INDEX.md +39 -39
- package/templates/base/indexes/search/CATEGORY_INDEX.md +39 -39
- package/templates/base/indexes/workflows/CATEGORY_INDEX.md +38 -38
- package/templates/base/knowledge/README.md +98 -98
- package/templates/base/knowledge/sessions/README.md +88 -88
- package/templates/base/knowledge/sessions/TEMPLATE.md +150 -150
- package/templates/base/knowledge/shared/decisions/0001-adopt-context-engineering.md +144 -144
- package/templates/base/knowledge/shared/decisions/README.md +49 -49
- package/templates/base/knowledge/shared/decisions/TEMPLATE.md +123 -123
- package/templates/base/knowledge/shared/patterns/README.md +62 -62
- package/templates/base/knowledge/shared/patterns/TEMPLATE.md +120 -120
- package/templates/base/plans/PLAN_TEMPLATE.md +316 -250
- package/templates/base/research/RESEARCH_TEMPLATE.md +245 -153
- package/templates/base/schemas/agent.schema.json +141 -141
- package/templates/base/schemas/anchors.schema.json +54 -54
- package/templates/base/schemas/automation.schema.json +93 -93
- package/templates/base/schemas/command.schema.json +134 -134
- package/templates/base/schemas/hashes.schema.json +40 -40
- package/templates/base/schemas/manifest.schema.json +117 -117
- package/templates/base/schemas/plan.schema.json +136 -136
- package/templates/base/schemas/research.schema.json +115 -115
- package/templates/base/schemas/roles.schema.json +34 -34
- package/templates/base/schemas/session.schema.json +77 -77
- package/templates/base/schemas/settings.schema.json +244 -244
- package/templates/base/schemas/staleness.schema.json +53 -53
- package/templates/base/schemas/team-config.schema.json +42 -42
- package/templates/base/schemas/workflow.schema.json +126 -126
- package/templates/base/session/checkpoints/.gitkeep +2 -2
- package/templates/base/session/current/state.json +20 -20
- package/templates/base/session/history/.gitkeep +2 -2
- package/templates/base/settings.json +3 -3
- package/templates/base/standards/COMPATIBILITY.md +219 -219
- package/templates/base/standards/EXTENSION_GUIDELINES.md +280 -280
- package/templates/base/standards/QUALITY_CHECKLIST.md +211 -211
- package/templates/base/standards/README.md +66 -66
- package/templates/base/sync/anchors.json +6 -6
- package/templates/base/sync/hashes.json +6 -6
- package/templates/base/sync/staleness.json +10 -10
- package/templates/base/team/README.md +168 -168
- package/templates/base/team/config.json +79 -79
- package/templates/base/team/roles.json +145 -145
- package/templates/base/tools/bin/claude-context.js +151 -151
- package/templates/base/tools/lib/anchor-resolver.js +276 -276
- package/templates/base/tools/lib/config-loader.js +363 -363
- package/templates/base/tools/lib/detector.js +350 -350
- package/templates/base/tools/lib/diagnose.js +206 -206
- package/templates/base/tools/lib/drift-detector.js +373 -373
- package/templates/base/tools/lib/errors.js +199 -199
- package/templates/base/tools/lib/index.js +36 -36
- package/templates/base/tools/lib/init.js +192 -192
- package/templates/base/tools/lib/logger.js +230 -230
- package/templates/base/tools/lib/placeholder.js +201 -201
- package/templates/base/tools/lib/session-manager.js +354 -354
- package/templates/base/tools/lib/validate.js +521 -521
- package/templates/base/tools/package.json +49 -49
- package/templates/handlebars/aider-config.hbs +146 -80
- package/templates/handlebars/antigravity.hbs +377 -377
- package/templates/handlebars/claude.hbs +183 -183
- package/templates/handlebars/cline.hbs +62 -62
- package/templates/handlebars/continue-config.hbs +116 -116
- package/templates/handlebars/copilot.hbs +130 -130
- package/templates/handlebars/partials/gotcha-list.hbs +11 -11
- package/templates/handlebars/partials/header.hbs +3 -3
- package/templates/handlebars/partials/workflow-summary.hbs +16 -16
- package/templates/handlebars/windsurf-rules.hbs +69 -69
- package/templates/hooks/post-commit.hbs +28 -29
- package/templates/hooks/pre-commit.hbs +46 -46
|
@@ -1,95 +1,95 @@
|
|
|
1
|
-
# Testing Map
|
|
2
|
-
|
|
3
|
-
> Maps source files to their corresponding tests.
|
|
4
|
-
> **Last Updated:** {{LAST_UPDATED}}
|
|
5
|
-
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## Overview
|
|
9
|
-
|
|
10
|
-
This document provides a mapping between source files and their test coverage, helping developers find and update tests when modifying code.
|
|
11
|
-
|
|
12
|
-
---
|
|
13
|
-
|
|
14
|
-
## Test Structure
|
|
15
|
-
|
|
16
|
-
```
|
|
17
|
-
tests/
|
|
18
|
-
├── unit/ # Unit tests
|
|
19
|
-
├── integration/ # Integration tests
|
|
20
|
-
├── e2e/ # End-to-end tests
|
|
21
|
-
└── fixtures/ # Test data and mocks
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
---
|
|
25
|
-
|
|
26
|
-
## Coverage Summary
|
|
27
|
-
|
|
28
|
-
| Category | Files | Covered | Coverage |
|
|
29
|
-
|----------|-------|---------|----------|
|
|
30
|
-
| Unit | {{UNIT_COUNT}} | {{UNIT_COVERED}} | {{UNIT_PCT}}% |
|
|
31
|
-
| Integration | {{INT_COUNT}} | {{INT_COVERED}} | {{INT_PCT}}% |
|
|
32
|
-
| E2E | {{E2E_COUNT}} | {{E2E_COVERED}} | {{E2E_PCT}}% |
|
|
33
|
-
|
|
34
|
-
---
|
|
35
|
-
|
|
36
|
-
## File-to-Test Mapping
|
|
37
|
-
|
|
38
|
-
### Core Application
|
|
39
|
-
|
|
40
|
-
| Source File | Test File | Coverage |
|
|
41
|
-
|-------------|-----------|----------|
|
|
42
|
-
| `src/{{file}}.{{ext}}` | `tests/unit/{{file}}.test.{{ext}}` | {{PCT}}% |
|
|
43
|
-
|
|
44
|
-
### Services
|
|
45
|
-
|
|
46
|
-
| Source File | Test File | Coverage |
|
|
47
|
-
|-------------|-----------|----------|
|
|
48
|
-
| `src/services/{{service}}.{{ext}}` | `tests/unit/services/{{service}}.test.{{ext}}` | {{PCT}}% |
|
|
49
|
-
|
|
50
|
-
### Utilities
|
|
51
|
-
|
|
52
|
-
| Source File | Test File | Coverage |
|
|
53
|
-
|-------------|-----------|----------|
|
|
54
|
-
| `src/utils/{{util}}.{{ext}}` | `tests/unit/utils/{{util}}.test.{{ext}}` | {{PCT}}% |
|
|
55
|
-
|
|
56
|
-
---
|
|
57
|
-
|
|
58
|
-
## Critical Paths
|
|
59
|
-
|
|
60
|
-
These files require comprehensive test coverage:
|
|
61
|
-
|
|
62
|
-
| Path | Reason | Minimum Coverage |
|
|
63
|
-
|------|--------|------------------|
|
|
64
|
-
| `src/auth/` | Security-critical | 90% |
|
|
65
|
-
| `src/payment/` | Financial transactions | 95% |
|
|
66
|
-
| `src/api/` | Public interface | 85% |
|
|
67
|
-
|
|
68
|
-
---
|
|
69
|
-
|
|
70
|
-
## Test Commands
|
|
71
|
-
|
|
72
|
-
```bash
|
|
73
|
-
# Run all tests
|
|
74
|
-
{{TEST_COMMAND}}
|
|
75
|
-
|
|
76
|
-
# Run with coverage
|
|
77
|
-
{{COVERAGE_COMMAND}}
|
|
78
|
-
|
|
79
|
-
# Run specific test
|
|
80
|
-
{{SPECIFIC_TEST_COMMAND}}
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
---
|
|
84
|
-
|
|
85
|
-
## Maintenance
|
|
86
|
-
|
|
87
|
-
Update this file when:
|
|
88
|
-
- New source files are added
|
|
89
|
-
- New test files are created
|
|
90
|
-
- Coverage thresholds change
|
|
91
|
-
- Test structure changes
|
|
92
|
-
|
|
93
|
-
---
|
|
94
|
-
|
|
95
|
-
*Template file - populate with actual test coverage data*
|
|
1
|
+
# Testing Map
|
|
2
|
+
|
|
3
|
+
> Maps source files to their corresponding tests.
|
|
4
|
+
> **Last Updated:** {{LAST_UPDATED}}
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
This document provides a mapping between source files and their test coverage, helping developers find and update tests when modifying code.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Test Structure
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
tests/
|
|
18
|
+
├── unit/ # Unit tests
|
|
19
|
+
├── integration/ # Integration tests
|
|
20
|
+
├── e2e/ # End-to-end tests
|
|
21
|
+
└── fixtures/ # Test data and mocks
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Coverage Summary
|
|
27
|
+
|
|
28
|
+
| Category | Files | Covered | Coverage |
|
|
29
|
+
|----------|-------|---------|----------|
|
|
30
|
+
| Unit | {{UNIT_COUNT}} | {{UNIT_COVERED}} | {{UNIT_PCT}}% |
|
|
31
|
+
| Integration | {{INT_COUNT}} | {{INT_COVERED}} | {{INT_PCT}}% |
|
|
32
|
+
| E2E | {{E2E_COUNT}} | {{E2E_COVERED}} | {{E2E_PCT}}% |
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## File-to-Test Mapping
|
|
37
|
+
|
|
38
|
+
### Core Application
|
|
39
|
+
|
|
40
|
+
| Source File | Test File | Coverage |
|
|
41
|
+
|-------------|-----------|----------|
|
|
42
|
+
| `src/{{file}}.{{ext}}` | `tests/unit/{{file}}.test.{{ext}}` | {{PCT}}% |
|
|
43
|
+
|
|
44
|
+
### Services
|
|
45
|
+
|
|
46
|
+
| Source File | Test File | Coverage |
|
|
47
|
+
|-------------|-----------|----------|
|
|
48
|
+
| `src/services/{{service}}.{{ext}}` | `tests/unit/services/{{service}}.test.{{ext}}` | {{PCT}}% |
|
|
49
|
+
|
|
50
|
+
### Utilities
|
|
51
|
+
|
|
52
|
+
| Source File | Test File | Coverage |
|
|
53
|
+
|-------------|-----------|----------|
|
|
54
|
+
| `src/utils/{{util}}.{{ext}}` | `tests/unit/utils/{{util}}.test.{{ext}}` | {{PCT}}% |
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Critical Paths
|
|
59
|
+
|
|
60
|
+
These files require comprehensive test coverage:
|
|
61
|
+
|
|
62
|
+
| Path | Reason | Minimum Coverage |
|
|
63
|
+
|------|--------|------------------|
|
|
64
|
+
| `src/auth/` | Security-critical | 90% |
|
|
65
|
+
| `src/payment/` | Financial transactions | 95% |
|
|
66
|
+
| `src/api/` | Public interface | 85% |
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## Test Commands
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
# Run all tests
|
|
74
|
+
{{TEST_COMMAND}}
|
|
75
|
+
|
|
76
|
+
# Run with coverage
|
|
77
|
+
{{COVERAGE_COMMAND}}
|
|
78
|
+
|
|
79
|
+
# Run specific test
|
|
80
|
+
{{SPECIFIC_TEST_COMMAND}}
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## Maintenance
|
|
86
|
+
|
|
87
|
+
Update this file when:
|
|
88
|
+
- New source files are added
|
|
89
|
+
- New test files are created
|
|
90
|
+
- Coverage thresholds change
|
|
91
|
+
- Test structure changes
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
*Template file - populate with actual test coverage data*
|
|
@@ -1,129 +1,129 @@
|
|
|
1
|
-
# Workflow Index - {{PROJECT_NAME}}
|
|
2
|
-
|
|
3
|
-
**Purpose:** Master catalog of all documented workflows
|
|
4
|
-
**Load First:** Always load this file before debugging/implementing
|
|
5
|
-
**Size:** ~15k tokens (7.5% of 200k context budget)
|
|
6
|
-
**Last Updated:** {{DATE}}
|
|
7
|
-
|
|
8
|
-
---
|
|
9
|
-
|
|
10
|
-
## Quick Navigation
|
|
11
|
-
|
|
12
|
-
| # | Workflow | Complexity | Entry Point | Use When |
|
|
13
|
-
|---|----------|------------|-------------|----------|
|
|
14
|
-
| 1 | {{WORKFLOW_1}} | HIGH/MED/LOW | [file:line] | [Scenario] |
|
|
15
|
-
| 2 | {{WORKFLOW_2}} | HIGH/MED/LOW | [file:line] | [Scenario] |
|
|
16
|
-
| 3 | {{WORKFLOW_3}} | HIGH/MED/LOW | [file:line] | [Scenario] |
|
|
17
|
-
|
|
18
|
-
---
|
|
19
|
-
|
|
20
|
-
## Workflow Categories
|
|
21
|
-
|
|
22
|
-
### Category 1: {{CATEGORY_1_NAME}}
|
|
23
|
-
|
|
24
|
-
**Workflows:** X
|
|
25
|
-
**Total Lines:** ~XXX lines
|
|
26
|
-
**Primary Agent:** {{AGENT_NAME}}
|
|
27
|
-
|
|
28
|
-
| Workflow | Lines | Purpose |
|
|
29
|
-
|----------|-------|---------|
|
|
30
|
-
| [workflow_1.md](./workflows/workflow_1.md) | XXX | [Description] |
|
|
31
|
-
|
|
32
|
-
**Use This Category For:**
|
|
33
|
-
- [Scenario 1]
|
|
34
|
-
- [Scenario 2]
|
|
35
|
-
|
|
36
|
-
---
|
|
37
|
-
|
|
38
|
-
### Category 2: {{CATEGORY_2_NAME}}
|
|
39
|
-
|
|
40
|
-
[Same structure...]
|
|
41
|
-
|
|
42
|
-
---
|
|
43
|
-
|
|
44
|
-
## Cross-Reference Tables
|
|
45
|
-
|
|
46
|
-
### External APIs × Workflows
|
|
47
|
-
|
|
48
|
-
| API | Used By Workflows |
|
|
49
|
-
|-----|-------------------|
|
|
50
|
-
| {{API_1}} | workflow_1, workflow_2 |
|
|
51
|
-
| {{API_2}} | workflow_3 |
|
|
52
|
-
|
|
53
|
-
### Database Tables × Workflows
|
|
54
|
-
|
|
55
|
-
| Table | Used By Workflows |
|
|
56
|
-
|-------|-------------------|
|
|
57
|
-
| {{TABLE_1}} | workflow_1, workflow_4 |
|
|
58
|
-
| {{TABLE_2}} | workflow_2, workflow_3 |
|
|
59
|
-
|
|
60
|
-
### Test Files × Workflows
|
|
61
|
-
|
|
62
|
-
| Test File | Covers Workflows |
|
|
63
|
-
|-----------|------------------|
|
|
64
|
-
| `test_workflow_1.ext` | workflow_1 |
|
|
65
|
-
| `test_e2e.ext` | workflow_1, workflow_2 |
|
|
66
|
-
|
|
67
|
-
---
|
|
68
|
-
|
|
69
|
-
## Issue Triage Quick Reference
|
|
70
|
-
|
|
71
|
-
| Symptom | Check Workflow | Key File:Line |
|
|
72
|
-
|---------|---------------|---------------|
|
|
73
|
-
| [Issue type 1] | workflow_1 | file.ext:XXX |
|
|
74
|
-
| [Issue type 2] | workflow_2 | file.ext:YYY |
|
|
75
|
-
| [Issue type 3] | workflow_3 | file.ext:ZZZ |
|
|
76
|
-
|
|
77
|
-
---
|
|
78
|
-
|
|
79
|
-
## Context Engineering Usage
|
|
80
|
-
|
|
81
|
-
### Loading Strategy
|
|
82
|
-
|
|
83
|
-
```
|
|
84
|
-
Step 1: Load this file (~15k tokens)
|
|
85
|
-
Step 2: Identify relevant workflow(s)
|
|
86
|
-
Step 3: Load specific workflow file (~20-50k tokens)
|
|
87
|
-
Step 4: Read specific code sections as needed
|
|
88
|
-
|
|
89
|
-
Total: ~50-80k tokens (25-40% of budget)
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
### When to Load Full Workflow
|
|
93
|
-
|
|
94
|
-
- **Debugging:** Load the affected workflow immediately
|
|
95
|
-
- **Feature:** Load 2-3 related workflows
|
|
96
|
-
- **Refactoring:** Load primary + dependent workflows
|
|
97
|
-
|
|
98
|
-
### When NOT to Load Full Workflow
|
|
99
|
-
|
|
100
|
-
- **Simple fix:** Use this index + grep
|
|
101
|
-
- **Configuration change:** Direct file edit
|
|
102
|
-
- **Documentation update:** Direct doc edit
|
|
103
|
-
|
|
104
|
-
---
|
|
105
|
-
|
|
106
|
-
## Maintenance Schedule
|
|
107
|
-
|
|
108
|
-
| Task | Frequency | Time Required |
|
|
109
|
-
|------|-----------|---------------|
|
|
110
|
-
| Spot-check 5 line numbers | Monthly | 15 minutes |
|
|
111
|
-
| Re-run 3 discovery agents | Quarterly | 2 hours |
|
|
112
|
-
| Full documentation audit | Annually | 4-6 hours |
|
|
113
|
-
|
|
114
|
-
**Last Verification:** {{DATE}}
|
|
115
|
-
**Next Verification:** {{NEXT_DATE}}
|
|
116
|
-
|
|
117
|
-
---
|
|
118
|
-
|
|
119
|
-
## See Also
|
|
120
|
-
|
|
121
|
-
- **Detailed workflows:** [./workflows/](./workflows/)
|
|
122
|
-
- **Code organization:** [../indexes/code/CATEGORY_INDEX.md](../indexes/code/CATEGORY_INDEX.md)
|
|
123
|
-
- **Agent selection:** [../indexes/agents/CATEGORY_INDEX.md](../indexes/agents/CATEGORY_INDEX.md)
|
|
124
|
-
- **Reverse lookup:** [./CODE_TO_WORKFLOW_MAP.md](./CODE_TO_WORKFLOW_MAP.md)
|
|
125
|
-
|
|
126
|
-
---
|
|
127
|
-
|
|
128
|
-
**Version:** 1.0
|
|
129
|
-
**Total Workflows:** {{WORKFLOWS_COUNT}}
|
|
1
|
+
# Workflow Index - {{PROJECT_NAME}}
|
|
2
|
+
|
|
3
|
+
**Purpose:** Master catalog of all documented workflows
|
|
4
|
+
**Load First:** Always load this file before debugging/implementing
|
|
5
|
+
**Size:** ~15k tokens (7.5% of 200k context budget)
|
|
6
|
+
**Last Updated:** {{DATE}}
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Quick Navigation
|
|
11
|
+
|
|
12
|
+
| # | Workflow | Complexity | Entry Point | Use When |
|
|
13
|
+
|---|----------|------------|-------------|----------|
|
|
14
|
+
| 1 | {{WORKFLOW_1}} | HIGH/MED/LOW | [file:line] | [Scenario] |
|
|
15
|
+
| 2 | {{WORKFLOW_2}} | HIGH/MED/LOW | [file:line] | [Scenario] |
|
|
16
|
+
| 3 | {{WORKFLOW_3}} | HIGH/MED/LOW | [file:line] | [Scenario] |
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Workflow Categories
|
|
21
|
+
|
|
22
|
+
### Category 1: {{CATEGORY_1_NAME}}
|
|
23
|
+
|
|
24
|
+
**Workflows:** X
|
|
25
|
+
**Total Lines:** ~XXX lines
|
|
26
|
+
**Primary Agent:** {{AGENT_NAME}}
|
|
27
|
+
|
|
28
|
+
| Workflow | Lines | Purpose |
|
|
29
|
+
|----------|-------|---------|
|
|
30
|
+
| [workflow_1.md](./workflows/workflow_1.md) | XXX | [Description] |
|
|
31
|
+
|
|
32
|
+
**Use This Category For:**
|
|
33
|
+
- [Scenario 1]
|
|
34
|
+
- [Scenario 2]
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
### Category 2: {{CATEGORY_2_NAME}}
|
|
39
|
+
|
|
40
|
+
[Same structure...]
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## Cross-Reference Tables
|
|
45
|
+
|
|
46
|
+
### External APIs × Workflows
|
|
47
|
+
|
|
48
|
+
| API | Used By Workflows |
|
|
49
|
+
|-----|-------------------|
|
|
50
|
+
| {{API_1}} | workflow_1, workflow_2 |
|
|
51
|
+
| {{API_2}} | workflow_3 |
|
|
52
|
+
|
|
53
|
+
### Database Tables × Workflows
|
|
54
|
+
|
|
55
|
+
| Table | Used By Workflows |
|
|
56
|
+
|-------|-------------------|
|
|
57
|
+
| {{TABLE_1}} | workflow_1, workflow_4 |
|
|
58
|
+
| {{TABLE_2}} | workflow_2, workflow_3 |
|
|
59
|
+
|
|
60
|
+
### Test Files × Workflows
|
|
61
|
+
|
|
62
|
+
| Test File | Covers Workflows |
|
|
63
|
+
|-----------|------------------|
|
|
64
|
+
| `test_workflow_1.ext` | workflow_1 |
|
|
65
|
+
| `test_e2e.ext` | workflow_1, workflow_2 |
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## Issue Triage Quick Reference
|
|
70
|
+
|
|
71
|
+
| Symptom | Check Workflow | Key File:Line |
|
|
72
|
+
|---------|---------------|---------------|
|
|
73
|
+
| [Issue type 1] | workflow_1 | file.ext:XXX |
|
|
74
|
+
| [Issue type 2] | workflow_2 | file.ext:YYY |
|
|
75
|
+
| [Issue type 3] | workflow_3 | file.ext:ZZZ |
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## Context Engineering Usage
|
|
80
|
+
|
|
81
|
+
### Loading Strategy
|
|
82
|
+
|
|
83
|
+
```
|
|
84
|
+
Step 1: Load this file (~15k tokens)
|
|
85
|
+
Step 2: Identify relevant workflow(s)
|
|
86
|
+
Step 3: Load specific workflow file (~20-50k tokens)
|
|
87
|
+
Step 4: Read specific code sections as needed
|
|
88
|
+
|
|
89
|
+
Total: ~50-80k tokens (25-40% of budget)
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### When to Load Full Workflow
|
|
93
|
+
|
|
94
|
+
- **Debugging:** Load the affected workflow immediately
|
|
95
|
+
- **Feature:** Load 2-3 related workflows
|
|
96
|
+
- **Refactoring:** Load primary + dependent workflows
|
|
97
|
+
|
|
98
|
+
### When NOT to Load Full Workflow
|
|
99
|
+
|
|
100
|
+
- **Simple fix:** Use this index + grep
|
|
101
|
+
- **Configuration change:** Direct file edit
|
|
102
|
+
- **Documentation update:** Direct doc edit
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## Maintenance Schedule
|
|
107
|
+
|
|
108
|
+
| Task | Frequency | Time Required |
|
|
109
|
+
|------|-----------|---------------|
|
|
110
|
+
| Spot-check 5 line numbers | Monthly | 15 minutes |
|
|
111
|
+
| Re-run 3 discovery agents | Quarterly | 2 hours |
|
|
112
|
+
| Full documentation audit | Annually | 4-6 hours |
|
|
113
|
+
|
|
114
|
+
**Last Verification:** {{DATE}}
|
|
115
|
+
**Next Verification:** {{NEXT_DATE}}
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## See Also
|
|
120
|
+
|
|
121
|
+
- **Detailed workflows:** [./workflows/](./workflows/)
|
|
122
|
+
- **Code organization:** [../indexes/code/CATEGORY_INDEX.md](../indexes/code/CATEGORY_INDEX.md)
|
|
123
|
+
- **Agent selection:** [../indexes/agents/CATEGORY_INDEX.md](../indexes/agents/CATEGORY_INDEX.md)
|
|
124
|
+
- **Reverse lookup:** [./CODE_TO_WORKFLOW_MAP.md](./CODE_TO_WORKFLOW_MAP.md)
|
|
125
|
+
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
**Version:** 1.0
|
|
129
|
+
**Total Workflows:** {{WORKFLOWS_COUNT}}
|