@cubis/foundry 0.3.81 → 0.3.82
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/dist/cli/core.js +229 -52
- package/dist/cli/core.js.map +1 -1
- package/package.json +1 -1
- package/src/cli/core.ts +314 -89
- package/workflows/workflows/agent-environment-setup/platforms/antigravity/workflows/architecture.md +22 -5
- package/workflows/workflows/agent-environment-setup/platforms/antigravity/workflows/implement-track.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/antigravity/workflows/migrate.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/antigravity/workflows/mobile.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/antigravity/workflows/onboard.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/antigravity/workflows/orchestrate.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/antigravity/workflows/plan.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/antigravity/workflows/refactor.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/antigravity/workflows/release.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/antigravity/workflows/spec.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/claude/workflows/architecture.md +22 -5
- package/workflows/workflows/agent-environment-setup/platforms/claude/workflows/implement-track.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/claude/workflows/migrate.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/claude/workflows/mobile.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/claude/workflows/onboard.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/claude/workflows/orchestrate.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/claude/workflows/plan.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/claude/workflows/refactor.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/claude/workflows/release.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/claude/workflows/spec.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/codex/workflows/architecture.md +22 -5
- package/workflows/workflows/agent-environment-setup/platforms/codex/workflows/implement-track.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/codex/workflows/migrate.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/codex/workflows/mobile.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/codex/workflows/onboard.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/codex/workflows/orchestrate.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/codex/workflows/plan.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/codex/workflows/refactor.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/codex/workflows/release.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/codex/workflows/spec.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/copilot/workflows/architecture.md +22 -5
- package/workflows/workflows/agent-environment-setup/platforms/copilot/workflows/implement-track.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/copilot/workflows/migrate.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/copilot/workflows/mobile.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/copilot/workflows/onboard.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/copilot/workflows/orchestrate.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/copilot/workflows/plan.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/copilot/workflows/refactor.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/copilot/workflows/release.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/copilot/workflows/spec.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/gemini/workflows/architecture.md +22 -5
- package/workflows/workflows/agent-environment-setup/platforms/gemini/workflows/implement-track.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/gemini/workflows/migrate.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/gemini/workflows/mobile.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/gemini/workflows/onboard.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/gemini/workflows/orchestrate.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/gemini/workflows/plan.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/gemini/workflows/refactor.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/gemini/workflows/release.md +1 -1
- package/workflows/workflows/agent-environment-setup/platforms/gemini/workflows/spec.md +1 -1
- package/workflows/workflows/agent-environment-setup/shared/workflows/architecture.md +22 -5
- package/workflows/workflows/agent-environment-setup/shared/workflows/implement-track.md +1 -1
- package/workflows/workflows/agent-environment-setup/shared/workflows/migrate.md +1 -1
- package/workflows/workflows/agent-environment-setup/shared/workflows/mobile.md +1 -1
- package/workflows/workflows/agent-environment-setup/shared/workflows/onboard.md +1 -1
- package/workflows/workflows/agent-environment-setup/shared/workflows/orchestrate.md +1 -1
- package/workflows/workflows/agent-environment-setup/shared/workflows/plan.md +1 -1
- package/workflows/workflows/agent-environment-setup/shared/workflows/refactor.md +1 -1
- package/workflows/workflows/agent-environment-setup/shared/workflows/release.md +1 -1
- package/workflows/workflows/agent-environment-setup/shared/workflows/spec.md +1 -1
package/workflows/workflows/agent-environment-setup/platforms/copilot/workflows/orchestrate.md
CHANGED
|
@@ -20,7 +20,7 @@ Use this when a task spans multiple domains (backend + frontend, security + infr
|
|
|
20
20
|
|
|
21
21
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
22
22
|
- Attach the full task description, constraints, acceptance criteria, and relevant context when starting.
|
|
23
|
-
- Read `ENGINEERING_RULES.md` and `TECH.md` before decomposing non-trivial work
|
|
23
|
+
- Read `ENGINEERING_RULES.md` and `docs/foundation/TECH.md` before decomposing non-trivial work. Check `docs/foundation/TECH.md` for build/validation commands and `docs/foundation/PRODUCT.md` for domain glossary. Then reuse any existing `docs/specs/<spec-id>/` pack as the handoff source of truth.
|
|
24
24
|
|
|
25
25
|
## Skill Routing
|
|
26
26
|
|
|
@@ -31,7 +31,7 @@ Use this when starting a new feature, project, or significant change that needs
|
|
|
31
31
|
|
|
32
32
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
33
33
|
- Attach the feature request, problem statement, constraints, and any existing design documents.
|
|
34
|
-
- Read `ENGINEERING_RULES.md` first and `TECH.md` next when they exist before finalizing a non-trivial plan.
|
|
34
|
+
- Read `ENGINEERING_RULES.md` first and `docs/foundation/TECH.md` next when they exist before finalizing a non-trivial plan. Also check `docs/foundation/PRODUCT.md` for domain glossary and `docs/foundation/ARCHITECTURE.md` for crosscutting concerns and dependency rules.
|
|
35
35
|
- Reuse an existing `docs/specs/<spec-id>/` pack when the change already has one instead of creating a parallel planning track.
|
|
36
36
|
|
|
37
37
|
## Skill Routing
|
|
@@ -20,7 +20,7 @@ Use this when improving code structure, reducing tech debt, or modularizing with
|
|
|
20
20
|
|
|
21
21
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
22
22
|
- Attach the target code, pain points, and any constraints on what can change.
|
|
23
|
-
- Read `ENGINEERING_RULES.md` and `TECH.md` first so behavior-preserving structure changes do not drift from the accepted architecture contract.
|
|
23
|
+
- Read `ENGINEERING_RULES.md` and `docs/foundation/TECH.md` first so behavior-preserving structure changes do not drift from the accepted architecture contract. Check `docs/foundation/ARCHITECTURE.md` for `## Dependency Rules` and `## Crosscutting Concerns` before restructuring.
|
|
24
24
|
|
|
25
25
|
## Skill Routing
|
|
26
26
|
|
|
@@ -20,7 +20,7 @@ Use this when preparing a release, deploying to production, or managing a rollou
|
|
|
20
20
|
|
|
21
21
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
22
22
|
- Attach the release scope, version number, changelog draft, and deployment target.
|
|
23
|
-
- Read `ENGINEERING_RULES.md` and `TECH.md` before release if the shipped changes touched architecture, scaling assumptions, or design-system rules.
|
|
23
|
+
- Read `ENGINEERING_RULES.md` and `docs/foundation/TECH.md` before release if the shipped changes touched architecture, scaling assumptions, or design-system rules. Check `docs/foundation/TECH.md` for `## Build And Validation` and `## CI CD Pipeline` steps to verify the release pipeline.
|
|
24
24
|
|
|
25
25
|
## Skill Routing
|
|
26
26
|
|
|
@@ -38,7 +38,7 @@ Use this for non-trivial work that needs durable planning in Git before implemen
|
|
|
38
38
|
1. Determine whether the task is non-trivial enough to justify a spec pack.
|
|
39
39
|
2. Find an existing `docs/specs/<spec-id>/` pack or create a new stable `spec_id`.
|
|
40
40
|
3. Write or refresh the spec pack with brief, acceptance, tasks, traceability, and handoff files.
|
|
41
|
-
4. Record `architecture_impact`, `doc_impact`, and any required updates to `docs/foundation/PRODUCT.md`, `docs/foundation/ARCHITECTURE.md`, `ENGINEERING_RULES.md`, or `docs/foundation/TECH.md`.
|
|
41
|
+
4. Record `architecture_impact`, `doc_impact`, and any required updates to `docs/foundation/PRODUCT.md`, `docs/foundation/ARCHITECTURE.md`, `ENGINEERING_RULES.md`, or `docs/foundation/TECH.md`. If the change adds new terms, update the `## Domain Glossary` in `docs/foundation/PRODUCT.md`. If the change introduces new crosscutting patterns or tech debt, flag updates needed in `docs/foundation/ARCHITECTURE.md`.
|
|
42
42
|
5. Identify the next execution route and hand off without replanning the same work.
|
|
43
43
|
|
|
44
44
|
## Context notes
|
package/workflows/workflows/agent-environment-setup/platforms/gemini/workflows/architecture.md
CHANGED
|
@@ -40,25 +40,36 @@ Use this when the task is to declare, refresh, or validate the project backbone
|
|
|
40
40
|
3. Read `docs/foundation/PRODUCT.md`, `docs/foundation/ARCHITECTURE.md`, and `docs/foundation/TECH.md` in that order if they exist.
|
|
41
41
|
4. Update the managed foundation sections in `docs/foundation/PRODUCT.md`, `docs/foundation/ARCHITECTURE.md`, and `docs/foundation/TECH.md`.
|
|
42
42
|
5. Make `docs/foundation/ARCHITECTURE.md` explicitly state the architecture type in use and include a folder-structure guide for the important apps/packages/directories.
|
|
43
|
-
6. Add or refresh Mermaid diagrams and flow narratives inside `docs/foundation/ARCHITECTURE.md`
|
|
44
|
-
7.
|
|
45
|
-
8.
|
|
43
|
+
6. Add or refresh Mermaid diagrams (using fenced ```mermaid blocks with valid syntax) and flow narratives inside `docs/foundation/ARCHITECTURE.md`or`docs/foundation/TECH.md`when they clarify system behavior. Use`sequenceDiagram`for runtime flows and`graph TD`or`C4Context` for structural views.
|
|
44
|
+
7. Ensure `docs/foundation/PRODUCT.md` includes a `## Domain Glossary` defining project-specific terms so future agents use consistent vocabulary.
|
|
45
|
+
8. Ensure `docs/foundation/ARCHITECTURE.md` includes `## Crosscutting Concerns` (logging, auth, error handling patterns), `## Quality Requirements`, and `## Risks And Tech Debt` sections.
|
|
46
|
+
9. Ensure `docs/foundation/TECH.md` includes `## Build And Validation` (exact commands from clean clone to passing CI), `## CI CD Pipeline` (workflow files and triggers), and `## Error Patterns And Debugging` (common errors and resolutions).
|
|
47
|
+
10. Seed or refresh `docs/foundation/adr/README.md` and `docs/foundation/adr/0000-template.md`, and keep ADR linkage explicit when decisions should be durable.
|
|
48
|
+
11. Record whether the update was driven by a broader spec and whether future implementation must follow newly declared structure or product constraints.
|
|
46
49
|
|
|
47
50
|
## Context notes
|
|
48
51
|
|
|
49
52
|
- This workflow is route-fixed and skill-fixed: do not start with `route_resolve` or `skill_search`.
|
|
50
|
-
- `docs/foundation/PRODUCT.md` captures intent, `docs/foundation/ARCHITECTURE.md` captures accepted structure, and `docs/foundation/TECH.md` is the developer-facing technical map. Keep them aligned but not redundant.
|
|
51
|
-
- Favor a lean arc42/C4 style: clear scope, boundaries, building blocks, runtime flows, deployment/testing notes, and only diagrams that add real value.
|
|
53
|
+
- `docs/foundation/PRODUCT.md` captures intent and domain glossary, `docs/foundation/ARCHITECTURE.md` captures accepted structure and crosscutting concerns, and `docs/foundation/TECH.md` is the developer-facing technical map with build/validation commands. Keep them aligned but not redundant.
|
|
54
|
+
- Favor a lean arc42/C4 style: clear scope, boundaries, building blocks, runtime flows, crosscutting concerns, quality requirements, risks, deployment/testing notes, and only diagrams that add real value.
|
|
52
55
|
- `docs/foundation/ARCHITECTURE.md` should guide future contributors, not just describe the system. Be explicit about architecture style and folder ownership.
|
|
56
|
+
- `docs/foundation/TECH.md` should enable an AI agent to start working immediately: exact build commands, environment setup, error patterns, and validation steps.
|
|
53
57
|
- Prefer stable section headings over ad hoc prose so future refreshes stay clean and easy to diff.
|
|
58
|
+
- All generated markdown must use correct formatting: single H1, proper heading hierarchy, fenced code blocks with language identifiers, valid Mermaid syntax, and tables with header/separator rows.
|
|
54
59
|
- Preserve manual content outside the managed foundation sections.
|
|
55
60
|
- Mark non-applicable sections explicitly instead of silently omitting them.
|
|
61
|
+
- Use relative markdown links between foundation docs: `[ARCHITECTURE.md](docs/foundation/ARCHITECTURE.md)`.
|
|
56
62
|
|
|
57
63
|
## Verification
|
|
58
64
|
|
|
59
65
|
- Managed foundation sections exist in the target docs under `docs/foundation/`.
|
|
60
66
|
- Product intent, architecture style, dependency rules, and technical guidance are explicit.
|
|
67
|
+
- `docs/foundation/PRODUCT.md` includes a `## Domain Glossary` with project-specific terms.
|
|
68
|
+
- `docs/foundation/ARCHITECTURE.md` includes `## Crosscutting Concerns`, `## Quality Requirements`, and `## Risks And Tech Debt`.
|
|
61
69
|
- `docs/foundation/ARCHITECTURE.md` or `docs/foundation/TECH.md` includes flow text and at least one Mermaid diagram when the repo has meaningful flow complexity.
|
|
70
|
+
- `docs/foundation/TECH.md` includes `## Build And Validation` with exact commands and `## Error Patterns And Debugging`.
|
|
71
|
+
- All Mermaid diagrams use fenced ```mermaid blocks with valid syntax (no rendering errors).
|
|
72
|
+
- All markdown files use correct heading hierarchy (single H1, no skipped levels).
|
|
62
73
|
- The update records `doc_impact` and whether future feature work must refresh the docs again.
|
|
63
74
|
|
|
64
75
|
## Output Contract
|
|
@@ -79,10 +90,16 @@ ARCHITECTURE_WORKFLOW_RESULT:
|
|
|
79
90
|
style: <string>
|
|
80
91
|
dependency_rules: [<string>]
|
|
81
92
|
design_system_source: <string>
|
|
93
|
+
crosscutting_concerns: [<string>]
|
|
94
|
+
quality_requirements: [<string>]
|
|
95
|
+
risks_and_tech_debt: [<string>]
|
|
82
96
|
technical_snapshot:
|
|
83
97
|
topology: [<string>]
|
|
84
98
|
flows: [<string>]
|
|
85
99
|
diagrams: [<string>] | []
|
|
100
|
+
build_commands: [<string>]
|
|
101
|
+
error_patterns: [<string>] | []
|
|
102
|
+
product_glossary: [<string>] | []
|
|
86
103
|
doc_impact: rules | tech | both
|
|
87
104
|
next_actions: [<string>] | []
|
|
88
105
|
```
|
package/workflows/workflows/agent-environment-setup/platforms/gemini/workflows/implement-track.md
CHANGED
|
@@ -21,7 +21,7 @@ Use this for large-scale implementation work that spans multiple sessions or mil
|
|
|
21
21
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
22
22
|
- Attach the implementation plan, milestone definitions, and acceptance criteria per milestone.
|
|
23
23
|
- Reuse `docs/specs/<spec-id>/` when present instead of maintaining a separate progress source of truth.
|
|
24
|
-
- Read `ENGINEERING_RULES.md` first and `TECH.md` next before starting milestone execution.
|
|
24
|
+
- Read `ENGINEERING_RULES.md` first and `docs/foundation/TECH.md` next before starting milestone execution. Use `## Build And Validation` for the validated build sequence and `## Key Commands` for test/lint commands.
|
|
25
25
|
|
|
26
26
|
## Skill Routing
|
|
27
27
|
|
|
@@ -28,7 +28,7 @@ Use this for technology migrations, framework upgrades, dependency updates, or m
|
|
|
28
28
|
|
|
29
29
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
30
30
|
- Attach the migration target, current versions, breaking change lists, and impact assessment.
|
|
31
|
-
- Read `ENGINEERING_RULES.md` and `TECH.md` first because migrations often change accepted patterns and current-state architecture at the same time.
|
|
31
|
+
- Read `ENGINEERING_RULES.md` and `docs/foundation/TECH.md` first because migrations often change accepted patterns and current-state architecture at the same time. After migration, flag updates needed in `docs/foundation/ARCHITECTURE.md` for `## Risks And Tech Debt`.
|
|
32
32
|
|
|
33
33
|
## Skill Routing
|
|
34
34
|
|
|
@@ -20,7 +20,7 @@ Use this for mobile app development, Flutter architecture, Stitch-driven mobile
|
|
|
20
20
|
|
|
21
21
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
22
22
|
- Attach platform targets (iOS, Android, both), Flutter version, and relevant screen/feature context.
|
|
23
|
-
- Read `ENGINEERING_RULES.md` and `TECH.md` before implementing non-trivial mobile work so screens and features follow the declared architecture and design-system rules.
|
|
23
|
+
- Read `ENGINEERING_RULES.md` and `docs/foundation/TECH.md` before implementing non-trivial mobile work so screens and features follow the declared architecture and design-system rules. Check `docs/foundation/PRODUCT.md` for `## Domain Glossary` to use consistent terminology.
|
|
24
24
|
|
|
25
25
|
## Skill Routing
|
|
26
26
|
|
|
@@ -27,7 +27,7 @@ Use this when joining a new project, exploring an unfamiliar codebase, or prepar
|
|
|
27
27
|
|
|
28
28
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
29
29
|
- Provide the repo URL, focus areas, and any specific questions to answer during onboarding.
|
|
30
|
-
- Read `ENGINEERING_RULES.md` first
|
|
30
|
+
- Read `ENGINEERING_RULES.md` first, then `docs/foundation/TECH.md`, `docs/foundation/PRODUCT.md`, and `docs/foundation/ARCHITECTURE.md` when present so onboarding distinguishes the intended contract from current implementation reality. Use the `## Domain Glossary` in PRODUCT.md to learn project-specific terms, and `## Build And Validation` in TECH.md to set up the local environment.
|
|
31
31
|
|
|
32
32
|
## Skill Routing
|
|
33
33
|
|
package/workflows/workflows/agent-environment-setup/platforms/gemini/workflows/orchestrate.md
CHANGED
|
@@ -20,7 +20,7 @@ Use this when a task spans multiple domains (backend + frontend, security + infr
|
|
|
20
20
|
|
|
21
21
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
22
22
|
- Attach the full task description, constraints, acceptance criteria, and relevant context when starting.
|
|
23
|
-
- Read `ENGINEERING_RULES.md` and `TECH.md` before decomposing non-trivial work
|
|
23
|
+
- Read `ENGINEERING_RULES.md` and `docs/foundation/TECH.md` before decomposing non-trivial work. Check `docs/foundation/TECH.md` for build/validation commands and `docs/foundation/PRODUCT.md` for domain glossary. Then reuse any existing `docs/specs/<spec-id>/` pack as the handoff source of truth.
|
|
24
24
|
|
|
25
25
|
## Skill Routing
|
|
26
26
|
|
|
@@ -31,7 +31,7 @@ Use this when starting a new feature, project, or significant change that needs
|
|
|
31
31
|
|
|
32
32
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
33
33
|
- Attach the feature request, problem statement, constraints, and any existing design documents.
|
|
34
|
-
- Read `ENGINEERING_RULES.md` first and `TECH.md` next when they exist before finalizing a non-trivial plan.
|
|
34
|
+
- Read `ENGINEERING_RULES.md` first and `docs/foundation/TECH.md` next when they exist before finalizing a non-trivial plan. Also check `docs/foundation/PRODUCT.md` for domain glossary and `docs/foundation/ARCHITECTURE.md` for crosscutting concerns and dependency rules.
|
|
35
35
|
- Reuse an existing `docs/specs/<spec-id>/` pack when the change already has one instead of creating a parallel planning track.
|
|
36
36
|
|
|
37
37
|
## Skill Routing
|
|
@@ -20,7 +20,7 @@ Use this when improving code structure, reducing tech debt, or modularizing with
|
|
|
20
20
|
|
|
21
21
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
22
22
|
- Attach the target code, pain points, and any constraints on what can change.
|
|
23
|
-
- Read `ENGINEERING_RULES.md` and `TECH.md` first so behavior-preserving structure changes do not drift from the accepted architecture contract.
|
|
23
|
+
- Read `ENGINEERING_RULES.md` and `docs/foundation/TECH.md` first so behavior-preserving structure changes do not drift from the accepted architecture contract. Check `docs/foundation/ARCHITECTURE.md` for `## Dependency Rules` and `## Crosscutting Concerns` before restructuring.
|
|
24
24
|
|
|
25
25
|
## Skill Routing
|
|
26
26
|
|
|
@@ -20,7 +20,7 @@ Use this when preparing a release, deploying to production, or managing a rollou
|
|
|
20
20
|
|
|
21
21
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
22
22
|
- Attach the release scope, version number, changelog draft, and deployment target.
|
|
23
|
-
- Read `ENGINEERING_RULES.md` and `TECH.md` before release if the shipped changes touched architecture, scaling assumptions, or design-system rules.
|
|
23
|
+
- Read `ENGINEERING_RULES.md` and `docs/foundation/TECH.md` before release if the shipped changes touched architecture, scaling assumptions, or design-system rules. Check `docs/foundation/TECH.md` for `## Build And Validation` and `## CI CD Pipeline` steps to verify the release pipeline.
|
|
24
24
|
|
|
25
25
|
## Skill Routing
|
|
26
26
|
|
|
@@ -38,7 +38,7 @@ Use this for non-trivial work that needs durable planning in Git before implemen
|
|
|
38
38
|
1. Determine whether the task is non-trivial enough to justify a spec pack.
|
|
39
39
|
2. Find an existing `docs/specs/<spec-id>/` pack or create a new stable `spec_id`.
|
|
40
40
|
3. Write or refresh the spec pack with brief, acceptance, tasks, traceability, and handoff files.
|
|
41
|
-
4. Record `architecture_impact`, `doc_impact`, and any required updates to `docs/foundation/PRODUCT.md`, `docs/foundation/ARCHITECTURE.md`, `ENGINEERING_RULES.md`, or `docs/foundation/TECH.md`.
|
|
41
|
+
4. Record `architecture_impact`, `doc_impact`, and any required updates to `docs/foundation/PRODUCT.md`, `docs/foundation/ARCHITECTURE.md`, `ENGINEERING_RULES.md`, or `docs/foundation/TECH.md`. If the change adds new terms, update the `## Domain Glossary` in `docs/foundation/PRODUCT.md`. If the change introduces new crosscutting patterns or tech debt, flag updates needed in `docs/foundation/ARCHITECTURE.md`.
|
|
42
42
|
5. Identify the next execution route and hand off without replanning the same work.
|
|
43
43
|
|
|
44
44
|
## Context notes
|
|
@@ -40,25 +40,36 @@ Use this when the task is to declare, refresh, or validate the project backbone
|
|
|
40
40
|
3. Read `docs/foundation/PRODUCT.md`, `docs/foundation/ARCHITECTURE.md`, and `docs/foundation/TECH.md` in that order if they exist.
|
|
41
41
|
4. Update the managed foundation sections in `docs/foundation/PRODUCT.md`, `docs/foundation/ARCHITECTURE.md`, and `docs/foundation/TECH.md`.
|
|
42
42
|
5. Make `docs/foundation/ARCHITECTURE.md` explicitly state the architecture type in use and include a folder-structure guide for the important apps/packages/directories.
|
|
43
|
-
6. Add or refresh Mermaid diagrams and flow narratives inside `docs/foundation/ARCHITECTURE.md`
|
|
44
|
-
7.
|
|
45
|
-
8.
|
|
43
|
+
6. Add or refresh Mermaid diagrams (using fenced ```mermaid blocks with valid syntax) and flow narratives inside `docs/foundation/ARCHITECTURE.md`or`docs/foundation/TECH.md`when they clarify system behavior. Use`sequenceDiagram`for runtime flows and`graph TD`or`C4Context` for structural views.
|
|
44
|
+
7. Ensure `docs/foundation/PRODUCT.md` includes a `## Domain Glossary` defining project-specific terms so future agents use consistent vocabulary.
|
|
45
|
+
8. Ensure `docs/foundation/ARCHITECTURE.md` includes `## Crosscutting Concerns` (logging, auth, error handling patterns), `## Quality Requirements`, and `## Risks And Tech Debt` sections.
|
|
46
|
+
9. Ensure `docs/foundation/TECH.md` includes `## Build And Validation` (exact commands from clean clone to passing CI), `## CI CD Pipeline` (workflow files and triggers), and `## Error Patterns And Debugging` (common errors and resolutions).
|
|
47
|
+
10. Seed or refresh `docs/foundation/adr/README.md` and `docs/foundation/adr/0000-template.md`, and keep ADR linkage explicit when decisions should be durable.
|
|
48
|
+
11. Record whether the update was driven by a broader spec and whether future implementation must follow newly declared structure or product constraints.
|
|
46
49
|
|
|
47
50
|
## Context notes
|
|
48
51
|
|
|
49
52
|
- This workflow is route-fixed and skill-fixed: do not start with `route_resolve` or `skill_search`.
|
|
50
|
-
- `docs/foundation/PRODUCT.md` captures intent, `docs/foundation/ARCHITECTURE.md` captures accepted structure, and `docs/foundation/TECH.md` is the developer-facing technical map. Keep them aligned but not redundant.
|
|
51
|
-
- Favor a lean arc42/C4 style: clear scope, boundaries, building blocks, runtime flows, deployment/testing notes, and only diagrams that add real value.
|
|
53
|
+
- `docs/foundation/PRODUCT.md` captures intent and domain glossary, `docs/foundation/ARCHITECTURE.md` captures accepted structure and crosscutting concerns, and `docs/foundation/TECH.md` is the developer-facing technical map with build/validation commands. Keep them aligned but not redundant.
|
|
54
|
+
- Favor a lean arc42/C4 style: clear scope, boundaries, building blocks, runtime flows, crosscutting concerns, quality requirements, risks, deployment/testing notes, and only diagrams that add real value.
|
|
52
55
|
- `docs/foundation/ARCHITECTURE.md` should guide future contributors, not just describe the system. Be explicit about architecture style and folder ownership.
|
|
56
|
+
- `docs/foundation/TECH.md` should enable an AI agent to start working immediately: exact build commands, environment setup, error patterns, and validation steps.
|
|
53
57
|
- Prefer stable section headings over ad hoc prose so future refreshes stay clean and easy to diff.
|
|
58
|
+
- All generated markdown must use correct formatting: single H1, proper heading hierarchy, fenced code blocks with language identifiers, valid Mermaid syntax, and tables with header/separator rows.
|
|
54
59
|
- Preserve manual content outside the managed foundation sections.
|
|
55
60
|
- Mark non-applicable sections explicitly instead of silently omitting them.
|
|
61
|
+
- Use relative markdown links between foundation docs: `[ARCHITECTURE.md](docs/foundation/ARCHITECTURE.md)`.
|
|
56
62
|
|
|
57
63
|
## Verification
|
|
58
64
|
|
|
59
65
|
- Managed foundation sections exist in the target docs under `docs/foundation/`.
|
|
60
66
|
- Product intent, architecture style, dependency rules, and technical guidance are explicit.
|
|
67
|
+
- `docs/foundation/PRODUCT.md` includes a `## Domain Glossary` with project-specific terms.
|
|
68
|
+
- `docs/foundation/ARCHITECTURE.md` includes `## Crosscutting Concerns`, `## Quality Requirements`, and `## Risks And Tech Debt`.
|
|
61
69
|
- `docs/foundation/ARCHITECTURE.md` or `docs/foundation/TECH.md` includes flow text and at least one Mermaid diagram when the repo has meaningful flow complexity.
|
|
70
|
+
- `docs/foundation/TECH.md` includes `## Build And Validation` with exact commands and `## Error Patterns And Debugging`.
|
|
71
|
+
- All Mermaid diagrams use fenced ```mermaid blocks with valid syntax (no rendering errors).
|
|
72
|
+
- All markdown files use correct heading hierarchy (single H1, no skipped levels).
|
|
62
73
|
- The update records `doc_impact` and whether future feature work must refresh the docs again.
|
|
63
74
|
|
|
64
75
|
## Output Contract
|
|
@@ -79,10 +90,16 @@ ARCHITECTURE_WORKFLOW_RESULT:
|
|
|
79
90
|
style: <string>
|
|
80
91
|
dependency_rules: [<string>]
|
|
81
92
|
design_system_source: <string>
|
|
93
|
+
crosscutting_concerns: [<string>]
|
|
94
|
+
quality_requirements: [<string>]
|
|
95
|
+
risks_and_tech_debt: [<string>]
|
|
82
96
|
technical_snapshot:
|
|
83
97
|
topology: [<string>]
|
|
84
98
|
flows: [<string>]
|
|
85
99
|
diagrams: [<string>] | []
|
|
100
|
+
build_commands: [<string>]
|
|
101
|
+
error_patterns: [<string>] | []
|
|
102
|
+
product_glossary: [<string>] | []
|
|
86
103
|
doc_impact: rules | tech | both
|
|
87
104
|
next_actions: [<string>] | []
|
|
88
105
|
```
|
|
@@ -21,7 +21,7 @@ Use this for large-scale implementation work that spans multiple sessions or mil
|
|
|
21
21
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
22
22
|
- Attach the implementation plan, milestone definitions, and acceptance criteria per milestone.
|
|
23
23
|
- Reuse `docs/specs/<spec-id>/` when present instead of maintaining a separate progress source of truth.
|
|
24
|
-
- Read `ENGINEERING_RULES.md` first and `TECH.md` next before starting milestone execution.
|
|
24
|
+
- Read `ENGINEERING_RULES.md` first and `docs/foundation/TECH.md` next before starting milestone execution. Use `## Build And Validation` for the validated build sequence and `## Key Commands` for test/lint commands.
|
|
25
25
|
|
|
26
26
|
## Skill Routing
|
|
27
27
|
|
|
@@ -28,7 +28,7 @@ Use this for technology migrations, framework upgrades, dependency updates, or m
|
|
|
28
28
|
|
|
29
29
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
30
30
|
- Attach the migration target, current versions, breaking change lists, and impact assessment.
|
|
31
|
-
- Read `ENGINEERING_RULES.md` and `TECH.md` first because migrations often change accepted patterns and current-state architecture at the same time.
|
|
31
|
+
- Read `ENGINEERING_RULES.md` and `docs/foundation/TECH.md` first because migrations often change accepted patterns and current-state architecture at the same time. After migration, flag updates needed in `docs/foundation/ARCHITECTURE.md` for `## Risks And Tech Debt`.
|
|
32
32
|
|
|
33
33
|
## Skill Routing
|
|
34
34
|
|
|
@@ -20,7 +20,7 @@ Use this for mobile app development, Flutter architecture, Stitch-driven mobile
|
|
|
20
20
|
|
|
21
21
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
22
22
|
- Attach platform targets (iOS, Android, both), Flutter version, and relevant screen/feature context.
|
|
23
|
-
- Read `ENGINEERING_RULES.md` and `TECH.md` before implementing non-trivial mobile work so screens and features follow the declared architecture and design-system rules.
|
|
23
|
+
- Read `ENGINEERING_RULES.md` and `docs/foundation/TECH.md` before implementing non-trivial mobile work so screens and features follow the declared architecture and design-system rules. Check `docs/foundation/PRODUCT.md` for `## Domain Glossary` to use consistent terminology.
|
|
24
24
|
|
|
25
25
|
## Skill Routing
|
|
26
26
|
|
|
@@ -27,7 +27,7 @@ Use this when joining a new project, exploring an unfamiliar codebase, or prepar
|
|
|
27
27
|
|
|
28
28
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
29
29
|
- Provide the repo URL, focus areas, and any specific questions to answer during onboarding.
|
|
30
|
-
- Read `ENGINEERING_RULES.md` first
|
|
30
|
+
- Read `ENGINEERING_RULES.md` first, then `docs/foundation/TECH.md`, `docs/foundation/PRODUCT.md`, and `docs/foundation/ARCHITECTURE.md` when present so onboarding distinguishes the intended contract from current implementation reality. Use the `## Domain Glossary` in PRODUCT.md to learn project-specific terms, and `## Build And Validation` in TECH.md to set up the local environment.
|
|
31
31
|
|
|
32
32
|
## Skill Routing
|
|
33
33
|
|
|
@@ -20,7 +20,7 @@ Use this when a task spans multiple domains (backend + frontend, security + infr
|
|
|
20
20
|
|
|
21
21
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
22
22
|
- Attach the full task description, constraints, acceptance criteria, and relevant context when starting.
|
|
23
|
-
- Read `ENGINEERING_RULES.md` and `TECH.md` before decomposing non-trivial work
|
|
23
|
+
- Read `ENGINEERING_RULES.md` and `docs/foundation/TECH.md` before decomposing non-trivial work. Check `docs/foundation/TECH.md` for build/validation commands and `docs/foundation/PRODUCT.md` for domain glossary. Then reuse any existing `docs/specs/<spec-id>/` pack as the handoff source of truth.
|
|
24
24
|
|
|
25
25
|
## Skill Routing
|
|
26
26
|
|
|
@@ -31,7 +31,7 @@ Use this when starting a new feature, project, or significant change that needs
|
|
|
31
31
|
|
|
32
32
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
33
33
|
- Attach the feature request, problem statement, constraints, and any existing design documents.
|
|
34
|
-
- Read `ENGINEERING_RULES.md` first and `TECH.md` next when they exist before finalizing a non-trivial plan.
|
|
34
|
+
- Read `ENGINEERING_RULES.md` first and `docs/foundation/TECH.md` next when they exist before finalizing a non-trivial plan. Also check `docs/foundation/PRODUCT.md` for domain glossary and `docs/foundation/ARCHITECTURE.md` for crosscutting concerns and dependency rules.
|
|
35
35
|
- Reuse an existing `docs/specs/<spec-id>/` pack when the change already has one instead of creating a parallel planning track.
|
|
36
36
|
|
|
37
37
|
## Skill Routing
|
|
@@ -20,7 +20,7 @@ Use this when improving code structure, reducing tech debt, or modularizing with
|
|
|
20
20
|
|
|
21
21
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
22
22
|
- Attach the target code, pain points, and any constraints on what can change.
|
|
23
|
-
- Read `ENGINEERING_RULES.md` and `TECH.md` first so behavior-preserving structure changes do not drift from the accepted architecture contract.
|
|
23
|
+
- Read `ENGINEERING_RULES.md` and `docs/foundation/TECH.md` first so behavior-preserving structure changes do not drift from the accepted architecture contract. Check `docs/foundation/ARCHITECTURE.md` for `## Dependency Rules` and `## Crosscutting Concerns` before restructuring.
|
|
24
24
|
|
|
25
25
|
## Skill Routing
|
|
26
26
|
|
|
@@ -20,7 +20,7 @@ Use this when preparing a release, deploying to production, or managing a rollou
|
|
|
20
20
|
|
|
21
21
|
- This workflow file, active platform rules, and selected agents or skills guide execution.
|
|
22
22
|
- Attach the release scope, version number, changelog draft, and deployment target.
|
|
23
|
-
- Read `ENGINEERING_RULES.md` and `TECH.md` before release if the shipped changes touched architecture, scaling assumptions, or design-system rules.
|
|
23
|
+
- Read `ENGINEERING_RULES.md` and `docs/foundation/TECH.md` before release if the shipped changes touched architecture, scaling assumptions, or design-system rules. Check `docs/foundation/TECH.md` for `## Build And Validation` and `## CI CD Pipeline` steps to verify the release pipeline.
|
|
24
24
|
|
|
25
25
|
## Skill Routing
|
|
26
26
|
|
|
@@ -38,7 +38,7 @@ Use this for non-trivial work that needs durable planning in Git before implemen
|
|
|
38
38
|
1. Determine whether the task is non-trivial enough to justify a spec pack.
|
|
39
39
|
2. Find an existing `docs/specs/<spec-id>/` pack or create a new stable `spec_id`.
|
|
40
40
|
3. Write or refresh the spec pack with brief, acceptance, tasks, traceability, and handoff files.
|
|
41
|
-
4. Record `architecture_impact`, `doc_impact`, and any required updates to `docs/foundation/PRODUCT.md`, `docs/foundation/ARCHITECTURE.md`, `ENGINEERING_RULES.md`, or `docs/foundation/TECH.md`.
|
|
41
|
+
4. Record `architecture_impact`, `doc_impact`, and any required updates to `docs/foundation/PRODUCT.md`, `docs/foundation/ARCHITECTURE.md`, `ENGINEERING_RULES.md`, or `docs/foundation/TECH.md`. If the change adds new terms, update the `## Domain Glossary` in `docs/foundation/PRODUCT.md`. If the change introduces new crosscutting patterns or tech debt, flag updates needed in `docs/foundation/ARCHITECTURE.md`.
|
|
42
42
|
5. Identify the next execution route and hand off without replanning the same work.
|
|
43
43
|
|
|
44
44
|
## Context notes
|