@sallmarta/eye-hate-agent 1.0.3 → 1.0.5
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/README.md +52 -28
- package/docs/templates/project-docs-template/index.md +192 -50
- package/docs/templates/project-docs-template/technical-guidelines/index.md +50 -21
- package/docs/templates/reusable-prompts/00-project-docs-bootstrap.md +26 -43
- package/docs/templates/reusable-prompts/00-project-docs-parity.md +1 -1
- package/docs/templates/reusable-prompts/00-project-docs-refresh.md +9 -7
- package/docs/templates/reusable-prompts/01-sdd-execute.md +1 -1
- package/docs/templates/reusable-prompts/02-sdd-discuss.md +1 -1
- package/docs/templates/rules/agent-rules.md +1 -1
- package/docs/templates/skills/{architecture/api-design → api-design}/SKILL.md +14 -25
- package/docs/templates/skills/{auditing/full-verification → code-audit}/SKILL.md +35 -53
- package/docs/templates/skills/db-schema-design/SKILL.md +120 -0
- package/docs/templates/skills/devops-ci-cd/SKILL.md +99 -0
- package/docs/templates/skills/observability/SKILL.md +99 -0
- package/docs/templates/skills/{auditing/parity → parity-audit}/SKILL.md +24 -50
- package/docs/templates/skills/refactor/SKILL.md +100 -0
- package/docs/templates/skills/security-audit/SKILL.md +149 -0
- package/docs/templates/skills/{architecture/system-analysis → system-analysis}/SKILL.md +19 -41
- package/docs/templates/skills/{engineering/test-authoring → system-tester}/SKILL.md +28 -222
- package/docs/templates/skills/ui-ux-design/SKILL.md +102 -0
- package/docs/templates/skills/wireframing/SKILL.md +88 -0
- package/package.json +10 -6
- package/src/engine/index.js +2 -0
- package/src/engine/install.js +1 -3
- package/src/engine/runtime-adapters.js +7 -4
- package/src/engine/skill-registry.js +37 -32
- package/docs/templates/project-docs-template/foundation/architecture.md +0 -79
- package/docs/templates/project-docs-template/foundation/changelog.md +0 -53
- package/docs/templates/project-docs-template/foundation/feature-inventory.md +0 -46
- package/docs/templates/project-docs-template/foundation/phases.md +0 -60
- package/docs/templates/project-docs-template/foundation/prd.md +0 -69
- package/docs/templates/project-docs-template/foundation/status.md +0 -57
- package/docs/templates/project-docs-template/foundation/workflow.md +0 -59
- package/docs/templates/project-docs-template/getting-started.md +0 -52
- package/docs/templates/project-docs-template/operations/ci-cd.md +0 -56
- package/docs/templates/project-docs-template/operations/compliance.md +0 -46
- package/docs/templates/project-docs-template/operations/governance.md +0 -46
- package/docs/templates/project-docs-template/operations/observability.md +0 -53
- package/docs/templates/project-docs-template/operations/production-runbook.md +0 -62
- package/docs/templates/project-docs-template/operations/security.md +0 -49
- package/docs/templates/project-docs-template/technical/api-contract.md +0 -49
- package/docs/templates/project-docs-template/technical/database.md +0 -59
- package/docs/templates/project-docs-template/technical/error-handling.md +0 -54
- package/docs/templates/project-docs-template/technical/internationalization.md +0 -46
- package/docs/templates/project-docs-template/technical/testing.md +0 -57
- package/docs/templates/project-docs-template/technical/ui-ux.md +0 -68
- package/docs/templates/skills/architecture/db-schema-design/SKILL.md +0 -14
- package/docs/templates/skills/auditing/security-audit/SKILL.md +0 -170
- package/docs/templates/skills/engineering/refactor-specialist/SKILL.md +0 -13
- package/docs/templates/skills/engineering/ui-ux-implementation/SKILL.md +0 -13
- package/docs/templates/skills/operations/ci-cd-authoring/SKILL.md +0 -13
- package/docs/templates/skills/operations/observability-setup/SKILL.md +0 -13
|
@@ -4,57 +4,62 @@ const SKILL_DEFINITIONS = {
|
|
|
4
4
|
'system-analysis': {
|
|
5
5
|
id: 'system-analysis',
|
|
6
6
|
commandName: 'system-analysis',
|
|
7
|
-
repoRelativePath: path.join('docs', 'templates', 'skills', '
|
|
7
|
+
repoRelativePath: path.join('docs', 'templates', 'skills', 'system-analysis', 'SKILL.md'),
|
|
8
8
|
},
|
|
9
9
|
'api-design': {
|
|
10
10
|
id: 'api-design',
|
|
11
11
|
commandName: 'api-design',
|
|
12
|
-
repoRelativePath: path.join('docs', 'templates', 'skills', '
|
|
12
|
+
repoRelativePath: path.join('docs', 'templates', 'skills', 'api-design', 'SKILL.md'),
|
|
13
13
|
},
|
|
14
14
|
'db-schema-design': {
|
|
15
15
|
id: 'db-schema-design',
|
|
16
16
|
commandName: 'db-schema-design',
|
|
17
|
-
repoRelativePath: path.join('docs', 'templates', 'skills', '
|
|
17
|
+
repoRelativePath: path.join('docs', 'templates', 'skills', 'db-schema-design', 'SKILL.md'),
|
|
18
18
|
},
|
|
19
|
-
'
|
|
20
|
-
id: '
|
|
21
|
-
commandName: '
|
|
22
|
-
repoRelativePath: path.join('docs', 'templates', 'skills', '
|
|
19
|
+
'ui-ux-design': {
|
|
20
|
+
id: 'ui-ux-design',
|
|
21
|
+
commandName: 'ui-ux-design',
|
|
22
|
+
repoRelativePath: path.join('docs', 'templates', 'skills', 'ui-ux-design', 'SKILL.md'),
|
|
23
23
|
},
|
|
24
|
-
'
|
|
25
|
-
id: '
|
|
26
|
-
commandName: '
|
|
27
|
-
repoRelativePath: path.join('docs', 'templates', 'skills', '
|
|
24
|
+
'wireframing': {
|
|
25
|
+
id: 'wireframing',
|
|
26
|
+
commandName: 'wireframing',
|
|
27
|
+
repoRelativePath: path.join('docs', 'templates', 'skills', 'wireframing', 'SKILL.md'),
|
|
28
28
|
},
|
|
29
|
-
'
|
|
30
|
-
id: '
|
|
31
|
-
commandName: '
|
|
32
|
-
repoRelativePath: path.join('docs', 'templates', 'skills', '
|
|
29
|
+
'code-audit': {
|
|
30
|
+
id: 'code-audit',
|
|
31
|
+
commandName: 'code-audit',
|
|
32
|
+
repoRelativePath: path.join('docs', 'templates', 'skills', 'code-audit', 'SKILL.md'),
|
|
33
|
+
},
|
|
34
|
+
'parity-audit': {
|
|
35
|
+
id: 'parity-audit',
|
|
36
|
+
commandName: 'parity-audit',
|
|
37
|
+
repoRelativePath: path.join('docs', 'templates', 'skills', 'parity-audit', 'SKILL.md'),
|
|
33
38
|
},
|
|
34
39
|
'security-audit': {
|
|
35
40
|
id: 'security-audit',
|
|
36
41
|
commandName: 'security-audit',
|
|
37
|
-
repoRelativePath: path.join('docs', 'templates', 'skills', '
|
|
42
|
+
repoRelativePath: path.join('docs', 'templates', 'skills', 'security-audit', 'SKILL.md'),
|
|
38
43
|
},
|
|
39
|
-
'
|
|
40
|
-
id: '
|
|
41
|
-
commandName: '
|
|
42
|
-
repoRelativePath: path.join('docs', 'templates', 'skills', '
|
|
44
|
+
'system-tester': {
|
|
45
|
+
id: 'system-tester',
|
|
46
|
+
commandName: 'system-tester',
|
|
47
|
+
repoRelativePath: path.join('docs', 'templates', 'skills', 'system-tester', 'SKILL.md'),
|
|
43
48
|
},
|
|
44
|
-
'
|
|
45
|
-
id: '
|
|
46
|
-
commandName: '
|
|
47
|
-
repoRelativePath: path.join('docs', 'templates', 'skills', '
|
|
49
|
+
'devops-ci-cd': {
|
|
50
|
+
id: 'devops-ci-cd',
|
|
51
|
+
commandName: 'devops-ci-cd',
|
|
52
|
+
repoRelativePath: path.join('docs', 'templates', 'skills', 'devops-ci-cd', 'SKILL.md'),
|
|
48
53
|
},
|
|
49
|
-
'
|
|
50
|
-
id: '
|
|
51
|
-
commandName: '
|
|
52
|
-
repoRelativePath: path.join('docs', 'templates', 'skills', '
|
|
54
|
+
'observability': {
|
|
55
|
+
id: 'observability',
|
|
56
|
+
commandName: 'observability',
|
|
57
|
+
repoRelativePath: path.join('docs', 'templates', 'skills', 'observability', 'SKILL.md'),
|
|
53
58
|
},
|
|
54
|
-
'
|
|
55
|
-
id: '
|
|
56
|
-
commandName: '
|
|
57
|
-
repoRelativePath: path.join('docs', 'templates', 'skills', '
|
|
59
|
+
'refactor': {
|
|
60
|
+
id: 'refactor',
|
|
61
|
+
commandName: 'refactor',
|
|
62
|
+
repoRelativePath: path.join('docs', 'templates', 'skills', 'refactor', 'SKILL.md'),
|
|
58
63
|
},
|
|
59
64
|
};
|
|
60
65
|
|
|
@@ -1,79 +0,0 @@
|
|
|
1
|
-
# Architecture
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Briefly describe the purpose of this document and what it contains.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Tech Stack Overview
|
|
28
|
-
| Area | Choice | Notes |
|
|
29
|
-
| --- | --- | --- |
|
|
30
|
-
| Application or service | TBD | |
|
|
31
|
-
| Runtime or platform | TBD | |
|
|
32
|
-
| Storage | TBD | |
|
|
33
|
-
| External integrations | TBD | |
|
|
34
|
-
|
|
35
|
-
## 8. Architecture Pattern
|
|
36
|
-
Describe architecture design pattern, system topology, component boundaries, and foundational control flow.
|
|
37
|
-
|
|
38
|
-
## 9. System Flow
|
|
39
|
-
General overview of how the system work from start to end. Diagram or flowchart visual are preferred. Use mermaid.
|
|
40
|
-
|
|
41
|
-
```mermaid
|
|
42
|
-
graph TD
|
|
43
|
-
A[Start] --> B{Decision}
|
|
44
|
-
B -- Yes --> C[Result 1]
|
|
45
|
-
B -- No --> D[Result 2]
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
## 10. Data Flow
|
|
49
|
-
General overview of inter-feature data flow, mapped against architectural patterns and system flow. Diagram or flowchart visual are preferred. Use mermaid.
|
|
50
|
-
|
|
51
|
-
```mermaid
|
|
52
|
-
sequenceDiagram
|
|
53
|
-
participant User
|
|
54
|
-
participant System
|
|
55
|
-
User->>System: Data Request
|
|
56
|
-
System-->>User: Data Response
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
## 11. Tools Integration
|
|
60
|
-
Such as hardware or software or external api and relevant tools. Can be empty.
|
|
61
|
-
|
|
62
|
-
| Integration | Purpose | Kind | Notes |
|
|
63
|
-
| --- | --- | --- | --- |
|
|
64
|
-
| TBD | TBD | TBD | *Software/Hardware/APIs/Other* |
|
|
65
|
-
|
|
66
|
-
## 12. Global Parameters and Constraints
|
|
67
|
-
Detail the system's global restrictions, such as performance requirements, caching policies, and error-handling mechanisms (e.g., "Supports offline execution for core features" or "Memory footprint restricted to 50MB").
|
|
68
|
-
|
|
69
|
-
## 13. Architecture Decision Records (ADRs)
|
|
70
|
-
A collection of ADRs documenting the rationale behind technical decision (e.g., "Choosing React over Vue for state management flexibility" or "Adopting Domain-Driven Design to leverage bounded contexts").
|
|
71
|
-
|
|
72
|
-
## 14. Success Metrics
|
|
73
|
-
How we measure if the goals of this document are achieved.
|
|
74
|
-
|
|
75
|
-
## 15. Related Documents
|
|
76
|
-
[Link to related document](path) - Short brief note about why it's related (e.g., [Guidelines](path) - technical implementation rules).
|
|
77
|
-
|
|
78
|
-
## 16. Open Questions
|
|
79
|
-
Unresolved architectural questions or assumptions. Can be empty.
|
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
# System Name Changelog
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Briefly describe the purpose of this document and what it contains.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. [Unreleased]
|
|
28
|
-
### 7.1. Added
|
|
29
|
-
TBD
|
|
30
|
-
|
|
31
|
-
### 7.2. Changed
|
|
32
|
-
TBD
|
|
33
|
-
|
|
34
|
-
### 7.3. Deprecated
|
|
35
|
-
TBD
|
|
36
|
-
|
|
37
|
-
### 7.4. Removed
|
|
38
|
-
TBD
|
|
39
|
-
|
|
40
|
-
### 7.5. Fixed
|
|
41
|
-
TBD
|
|
42
|
-
|
|
43
|
-
### 7.6. Security
|
|
44
|
-
TBD
|
|
45
|
-
|
|
46
|
-
## 8. Success Metrics
|
|
47
|
-
How we measure if the goals of this document are achieved.
|
|
48
|
-
|
|
49
|
-
## 9. Related Documents
|
|
50
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
51
|
-
|
|
52
|
-
## 10. Open Questions
|
|
53
|
-
Any unresolved questions or assumptions. Can be empty.
|
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
# Feature Inventory
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Briefly describe the purpose of this document and what it contains.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Feature Summary
|
|
28
|
-
High-level overview of the active feature set.
|
|
29
|
-
|
|
30
|
-
## 8. Core Functions (Epic-level)
|
|
31
|
-
Major active functional blocks mapping directly to code.
|
|
32
|
-
|
|
33
|
-
## 9. Sub-Functions (Task-level)
|
|
34
|
-
Granular interactions and capabilities currently live.
|
|
35
|
-
|
|
36
|
-
## 10. Deprecated / Removed Features
|
|
37
|
-
Historical record of retired capabilities.
|
|
38
|
-
|
|
39
|
-
## 11. Success Metrics
|
|
40
|
-
How we measure if the goals of this document are achieved.
|
|
41
|
-
|
|
42
|
-
## 12. Related Documents
|
|
43
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
44
|
-
|
|
45
|
-
## 13. Open Questions
|
|
46
|
-
Any unresolved questions or assumptions. Can be empty.
|
|
@@ -1,60 +0,0 @@
|
|
|
1
|
-
# Phases
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Briefly describe the purpose of this document and what it contains.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Overall Project Timeline
|
|
28
|
-
High-level estimate and major milestones. Visual timelines are preferred. Use mermaid.
|
|
29
|
-
|
|
30
|
-
```mermaid
|
|
31
|
-
gantt
|
|
32
|
-
title Project Timeline
|
|
33
|
-
dateFormat YYYY-MM-DD
|
|
34
|
-
section Phase 1
|
|
35
|
-
Milestone 1 : 2024-01-01, 30d
|
|
36
|
-
section Phase 2
|
|
37
|
-
Milestone 2 : 2024-02-01, 30d
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
## 8. Phase Registry
|
|
41
|
-
Links to individual markdown files in the `phases/` directory.
|
|
42
|
-
|
|
43
|
-
## 9. Sprint Tracker
|
|
44
|
-
### 9.1. Current Sprint (Date Range)
|
|
45
|
-
TBD
|
|
46
|
-
|
|
47
|
-
### 9.2. Active Tasks
|
|
48
|
-
TBD
|
|
49
|
-
|
|
50
|
-
### 9.3. Blockers
|
|
51
|
-
TBD
|
|
52
|
-
|
|
53
|
-
## 10. Success Metrics
|
|
54
|
-
How we measure if the goals of this document are achieved.
|
|
55
|
-
|
|
56
|
-
## 11. Related Documents
|
|
57
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
58
|
-
|
|
59
|
-
## 12. Open Questions
|
|
60
|
-
Any unresolved questions or assumptions. Can be empty.
|
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
# Product Requirements Document (PRD)
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Summarize the product, system, or major epic requirement set at a high level.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Vision Statement
|
|
28
|
-
A single, powerful sentence defining the ultimate end-state of the project.
|
|
29
|
-
|
|
30
|
-
## 8. Target Personas
|
|
31
|
-
Specific user types (e.g., Admin, Guest) to give the team empathy.
|
|
32
|
-
|
|
33
|
-
## 9. Core Business Value
|
|
34
|
-
The primary ROI, problem being solved, or operational improvement. Why does this project matter now?
|
|
35
|
-
|
|
36
|
-
## 10. User Journeys & App Flow
|
|
37
|
-
Flowcharts mapping the user's path through the app. Use mermaid.
|
|
38
|
-
|
|
39
|
-
```mermaid
|
|
40
|
-
journey
|
|
41
|
-
title User Journey Example
|
|
42
|
-
section Login
|
|
43
|
-
Enter credentials: 5: User
|
|
44
|
-
Authenticate: 5: System
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
## 11. Feature Workflows
|
|
48
|
-
Step-by-step logic flows for individual features. Use mermaid flowcharts to map complex feature logic.
|
|
49
|
-
|
|
50
|
-
## 12. Functional Requirements
|
|
51
|
-
Detailed list of functional capabilities.
|
|
52
|
-
|
|
53
|
-
## 13. Non-Functional Requirements
|
|
54
|
-
Reliability, performance, security, compliance, or UX expectations.
|
|
55
|
-
|
|
56
|
-
## 14. Acceptance Criteria
|
|
57
|
-
Specific criteria to verify the requirements are met.
|
|
58
|
-
|
|
59
|
-
## 15. External Dependencies & Partners
|
|
60
|
-
Third-party vendors and manual bottlenecks.
|
|
61
|
-
|
|
62
|
-
## 16. Success Metrics
|
|
63
|
-
How we measure if the goals of this document are achieved.
|
|
64
|
-
|
|
65
|
-
## 17. Related Documents
|
|
66
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
67
|
-
|
|
68
|
-
## 18. Open Questions
|
|
69
|
-
Any unresolved questions or assumptions. Can be empty.
|
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
# Status
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Briefly describe the purpose of this document and what it contains. (Note: This dashboard is updated automatically by the EHA agent).
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Current State
|
|
28
|
-
Summarize the current implementation state, maturity, and major constraints.
|
|
29
|
-
|
|
30
|
-
## 8. Recent Accomplishments
|
|
31
|
-
What was finished since the last update.
|
|
32
|
-
|
|
33
|
-
## 9. Upcoming Focus
|
|
34
|
-
What the team is tackling next week/month.
|
|
35
|
-
|
|
36
|
-
## 10. Key Metrics Health
|
|
37
|
-
Live data on project health (e.g., "Test Coverage: 85%", "Open Bugs: 12").
|
|
38
|
-
|
|
39
|
-
## 11. Roadmap
|
|
40
|
-
| Workstream | Status | Notes |
|
|
41
|
-
| --- | --- | --- |
|
|
42
|
-
| TBD | Planned | |
|
|
43
|
-
|
|
44
|
-
## 12. Epics
|
|
45
|
-
Active and upcoming epics.
|
|
46
|
-
|
|
47
|
-
## 13. Risks / Blockers
|
|
48
|
-
Immediate blockers holding up progress.
|
|
49
|
-
|
|
50
|
-
## 14. Success Metrics
|
|
51
|
-
How we measure if the goals of this document are achieved.
|
|
52
|
-
|
|
53
|
-
## 15. Related Documents
|
|
54
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
55
|
-
|
|
56
|
-
## 16. Open Questions
|
|
57
|
-
Any unresolved questions or assumptions. Can be empty.
|
|
@@ -1,59 +0,0 @@
|
|
|
1
|
-
# Workflow
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Briefly describe the purpose of this document and what it contains.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Local Development Loop
|
|
28
|
-
How to spin up and iterate.
|
|
29
|
-
|
|
30
|
-
## 8. Branching Strategy
|
|
31
|
-
GitFlow, Trunk-based, or custom rules. Diagram of branching logic is preferred. Use mermaid.
|
|
32
|
-
|
|
33
|
-
```mermaid
|
|
34
|
-
gitGraph
|
|
35
|
-
commit
|
|
36
|
-
branch develop
|
|
37
|
-
checkout develop
|
|
38
|
-
commit
|
|
39
|
-
branch feature
|
|
40
|
-
checkout feature
|
|
41
|
-
commit
|
|
42
|
-
checkout develop
|
|
43
|
-
merge feature
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
## 9. PR & Code Review Process
|
|
47
|
-
Required approvers, templates, and conventions.
|
|
48
|
-
|
|
49
|
-
## 10. Issue Tracking & Triage
|
|
50
|
-
How bugs and features are logged.
|
|
51
|
-
|
|
52
|
-
## 11. Success Metrics
|
|
53
|
-
How we measure if the goals of this document are achieved.
|
|
54
|
-
|
|
55
|
-
## 12. Related Documents
|
|
56
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
57
|
-
|
|
58
|
-
## 13. Open Questions
|
|
59
|
-
Any unresolved questions or assumptions. Can be empty.
|
|
@@ -1,52 +0,0 @@
|
|
|
1
|
-
# Getting Started
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Explain how to set up, run, and orient a new contributor or operator in this repository.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Prerequisites
|
|
28
|
-
Required tools, accounts, credentials, environment variables, or secrets handling.
|
|
29
|
-
|
|
30
|
-
## 8. First Steps
|
|
31
|
-
1. Clone or open the repository.
|
|
32
|
-
2. Install dependencies or required tools.
|
|
33
|
-
3. Configure local environment values.
|
|
34
|
-
4. Run the standard startup or verification commands.
|
|
35
|
-
|
|
36
|
-
## 9. Local Setup
|
|
37
|
-
Detailed steps for install, environment bootstrap, and local run.
|
|
38
|
-
|
|
39
|
-
## 10. Verification
|
|
40
|
-
First validation command and where to find deeper testing guidance (e.g., `testing.md`).
|
|
41
|
-
|
|
42
|
-
## 11. Troubleshooting
|
|
43
|
-
List known setup issues and their solutions.
|
|
44
|
-
|
|
45
|
-
## 12. Success Metrics
|
|
46
|
-
How we measure if the goals of this document are achieved.
|
|
47
|
-
|
|
48
|
-
## 13. Related Documents
|
|
49
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
50
|
-
|
|
51
|
-
## 14. Open Questions
|
|
52
|
-
Any unresolved questions or assumptions. Can be empty.
|
|
@@ -1,56 +0,0 @@
|
|
|
1
|
-
# CI/CD Configuration
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Briefly describe the purpose of this document and what it contains.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Pipeline Architecture
|
|
28
|
-
Overview of the branching and deployment flow. Flowcharts are preferred. Use mermaid.
|
|
29
|
-
|
|
30
|
-
```mermaid
|
|
31
|
-
graph LR
|
|
32
|
-
A[Commit] --> B[Build]
|
|
33
|
-
B --> C[Test]
|
|
34
|
-
C --> D[Deploy]
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
## 8. Build Steps
|
|
38
|
-
Compilation, bundling, and artifact generation.
|
|
39
|
-
|
|
40
|
-
## 9. Testing & Quality Gates
|
|
41
|
-
Automated tests, linting, and security scans.
|
|
42
|
-
|
|
43
|
-
## 10. Deployment Environments
|
|
44
|
-
Staging, UAT, and Production definitions.
|
|
45
|
-
|
|
46
|
-
## 11. Secrets & Environment Variables
|
|
47
|
-
Required credentials (stored securely).
|
|
48
|
-
|
|
49
|
-
## 12. Success Metrics
|
|
50
|
-
How we measure if the goals of this document are achieved.
|
|
51
|
-
|
|
52
|
-
## 13. Related Documents
|
|
53
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
54
|
-
|
|
55
|
-
## 14. Open Questions
|
|
56
|
-
Any unresolved questions or assumptions. Can be empty.
|
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
# Compliance
|
|
2
|
-
|
|
3
|
-
Last update: YYYY-MM-DD
|
|
4
|
-
|
|
5
|
-
Status: [Proposed | Draft | Live | Deprecated | Archived]
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Description
|
|
10
|
-
Briefly describe the purpose of this document and what it contains.
|
|
11
|
-
|
|
12
|
-
## 2. Important
|
|
13
|
-
Notes of important findings or critical constraints. Can be empty.
|
|
14
|
-
|
|
15
|
-
## 3. Table of Contents
|
|
16
|
-
[Generate a hyperlinked table of contents here containing ALL headings in this file (1 through N). Use standard markdown links, e.g., - [1. Description](#1-description)]
|
|
17
|
-
|
|
18
|
-
## 4. Scope
|
|
19
|
-
The boundaries of what this document covers.
|
|
20
|
-
|
|
21
|
-
## 5. Goals
|
|
22
|
-
What we aim to achieve with this specific document.
|
|
23
|
-
|
|
24
|
-
## 6. Non Goals
|
|
25
|
-
What is explicitly excluded from the scope of this document.
|
|
26
|
-
|
|
27
|
-
## 7. Data Privacy (GDPR / CCPA)
|
|
28
|
-
PII handling and user consent.
|
|
29
|
-
|
|
30
|
-
## 8. Data Retention Policy
|
|
31
|
-
How long logs and backups are kept before deletion.
|
|
32
|
-
|
|
33
|
-
## 9. Audit Logging
|
|
34
|
-
Tracking who modified what, and when.
|
|
35
|
-
|
|
36
|
-
## 10. Legal Disclaimers & Terms
|
|
37
|
-
Required user agreements and copyright notices.
|
|
38
|
-
|
|
39
|
-
## 11. Success Metrics
|
|
40
|
-
How we measure if the goals of this document are achieved.
|
|
41
|
-
|
|
42
|
-
## 12. Related Documents
|
|
43
|
-
[Link to related document](path) - Short brief note about why it's related.
|
|
44
|
-
|
|
45
|
-
## 13. Open Questions
|
|
46
|
-
Any unresolved questions or assumptions. Can be empty.
|