@sallmarta/eye-hate-agent 1.0.2 → 1.0.4

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.
Files changed (74) hide show
  1. package/README.md +56 -304
  2. package/bin/eha.js +203 -118
  3. package/docs/templates/project-docs-template/index.md +208 -0
  4. package/docs/templates/project-docs-template/technical-guidelines/index.md +81 -0
  5. package/docs/templates/reusable-prompts/00-project-docs-bootstrap.md +40 -0
  6. package/docs/{vibes → templates}/reusable-prompts/00-project-docs-parity.md +4 -6
  7. package/docs/{vibes → templates}/reusable-prompts/00-project-docs-refresh.md +11 -11
  8. package/docs/{vibes → templates}/reusable-prompts/01-sdd-execute.md +1 -1
  9. package/docs/{vibes → templates}/reusable-prompts/02-sdd-discuss.md +3 -3
  10. package/{.agents/rules/agent.md → docs/templates/rules/agent-rules.md} +7 -12
  11. package/docs/{vibes → templates}/skills/api-design/SKILL.md +14 -25
  12. package/docs/{vibes/skills/full-verification → templates/skills/code-audit}/SKILL.md +36 -54
  13. package/docs/templates/skills/db-schema-design/SKILL.md +120 -0
  14. package/docs/templates/skills/devops-ci-cd/SKILL.md +99 -0
  15. package/docs/templates/skills/observability/SKILL.md +99 -0
  16. package/docs/{vibes/skills/parity → templates/skills/parity-audit}/SKILL.md +26 -52
  17. package/docs/templates/skills/refactor/SKILL.md +100 -0
  18. package/docs/templates/skills/security-audit/SKILL.md +149 -0
  19. package/docs/{vibes/skills/analysis → templates/skills/system-analysis}/SKILL.md +19 -41
  20. package/docs/{vibes/skills/test-authoring → templates/skills/system-tester}/SKILL.md +28 -46
  21. package/docs/templates/skills/ui-ux-design/SKILL.md +102 -0
  22. package/docs/templates/skills/wireframing/SKILL.md +88 -0
  23. package/package.json +4 -6
  24. package/src/engine/index.js +9 -12
  25. package/src/engine/install.js +67 -165
  26. package/src/engine/runtime-adapters.js +266 -50
  27. package/src/engine/skill-registry.js +72 -0
  28. package/src/engine/state.js +29 -7
  29. package/src/engine/workflow-registry.js +14 -23
  30. package/.claude/commands/eha/README.md +0 -3
  31. package/.claude/commands/eha/eha-bootstrap.md +0 -9
  32. package/.claude/commands/eha/eha-discuss.md +0 -9
  33. package/.claude/commands/eha/eha-execute.md +0 -9
  34. package/.claude/commands/eha/eha-parity.md +0 -9
  35. package/.claude/commands/eha/eha-refresh.md +0 -9
  36. package/.claude/commands/eha/eha-verify.md +0 -9
  37. package/.claude/rules/agent-rules.md +0 -64
  38. package/.github/instructions/agent-rules.instructions.md +0 -63
  39. package/.github/instructions/eha-workflows.instructions.md +0 -21
  40. package/docs/eyehateagent-contract.md +0 -475
  41. package/docs/eyehateagent-maintenance.md +0 -103
  42. package/docs/project-docs/changelog.md +0 -299
  43. package/docs/project-docs/foundation/architecture.md +0 -117
  44. package/docs/project-docs/foundation/status.md +0 -32
  45. package/docs/project-docs/foundation/workflow.md +0 -63
  46. package/docs/project-docs/index.md +0 -20
  47. package/docs/project-docs/testing.md +0 -73
  48. package/docs/vibes/project-docs-template/foundation/architecture.md +0 -79
  49. package/docs/vibes/project-docs-template/foundation/changelog.md +0 -53
  50. package/docs/vibes/project-docs-template/foundation/feature-inventory.md +0 -46
  51. package/docs/vibes/project-docs-template/foundation/phases.md +0 -60
  52. package/docs/vibes/project-docs-template/foundation/prd.md +0 -69
  53. package/docs/vibes/project-docs-template/foundation/status.md +0 -57
  54. package/docs/vibes/project-docs-template/foundation/workflow.md +0 -59
  55. package/docs/vibes/project-docs-template/getting-started.md +0 -52
  56. package/docs/vibes/project-docs-template/index.md +0 -66
  57. package/docs/vibes/project-docs-template/operations/ci-cd.md +0 -56
  58. package/docs/vibes/project-docs-template/operations/compliance.md +0 -46
  59. package/docs/vibes/project-docs-template/operations/governance.md +0 -46
  60. package/docs/vibes/project-docs-template/operations/observability.md +0 -53
  61. package/docs/vibes/project-docs-template/operations/production-runbook.md +0 -62
  62. package/docs/vibes/project-docs-template/operations/security.md +0 -49
  63. package/docs/vibes/project-docs-template/technical/api-contract.md +0 -49
  64. package/docs/vibes/project-docs-template/technical/database.md +0 -59
  65. package/docs/vibes/project-docs-template/technical/error-handling.md +0 -54
  66. package/docs/vibes/project-docs-template/technical/internationalization.md +0 -46
  67. package/docs/vibes/project-docs-template/technical/testing.md +0 -57
  68. package/docs/vibes/project-docs-template/technical/ui-ux.md +0 -68
  69. package/docs/vibes/project-docs-template/technical-guidelines/index.md +0 -52
  70. package/docs/vibes/reusable-prompts/00-project-docs-bootstrap.md +0 -59
  71. package/docs/vibes/skills/code-audit/SKILL.md +0 -170
  72. package/docs/vibes/skills/project-elevation/SKILL.md +0 -157
  73. package/docs/vibes/skills/test-authoring/references/patterns.md +0 -116
  74. package/docs/vibes/skills/test-authoring/references/test-types.md +0 -52
@@ -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
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] 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
- > [!NOTE] Describe architecture design pattern, system topology, component boundaries, and foundational control flow.
37
-
38
- ## 9. System Flow
39
- > [!NOTE] 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
- > [!NOTE] 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
- > [!NOTE] 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
- > [!NOTE] 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
- > [!NOTE] 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
- > [!NOTE] How we measure if the goals of this document are achieved.
74
-
75
- ## 15. Related Documents
76
- > [!NOTE] [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
- > [!NOTE] 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
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. [Unreleased]
28
- ### 7.1. Added
29
- > [!NOTE] TBD
30
-
31
- ### 7.2. Changed
32
- > [!NOTE] TBD
33
-
34
- ### 7.3. Deprecated
35
- > [!NOTE] TBD
36
-
37
- ### 7.4. Removed
38
- > [!NOTE] TBD
39
-
40
- ### 7.5. Fixed
41
- > [!NOTE] TBD
42
-
43
- ### 7.6. Security
44
- > [!NOTE] TBD
45
-
46
- ## 8. Success Metrics
47
- > [!NOTE] How we measure if the goals of this document are achieved.
48
-
49
- ## 9. Related Documents
50
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
51
-
52
- ## 10. Open Questions
53
- > [!NOTE] 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
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Feature Summary
28
- > [!NOTE] High-level overview of the active feature set.
29
-
30
- ## 8. Core Functions (Epic-level)
31
- > [!NOTE] Major active functional blocks mapping directly to code.
32
-
33
- ## 9. Sub-Functions (Task-level)
34
- > [!NOTE] Granular interactions and capabilities currently live.
35
-
36
- ## 10. Deprecated / Removed Features
37
- > [!NOTE] Historical record of retired capabilities.
38
-
39
- ## 11. Success Metrics
40
- > [!NOTE] How we measure if the goals of this document are achieved.
41
-
42
- ## 12. Related Documents
43
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
44
-
45
- ## 13. Open Questions
46
- > [!NOTE] 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
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Overall Project Timeline
28
- > [!NOTE] 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
- > [!NOTE] Links to individual markdown files in the `phases/` directory.
42
-
43
- ## 9. Sprint Tracker
44
- ### 9.1. Current Sprint (Date Range)
45
- > [!NOTE] TBD
46
-
47
- ### 9.2. Active Tasks
48
- > [!NOTE] TBD
49
-
50
- ### 9.3. Blockers
51
- > [!NOTE] TBD
52
-
53
- ## 10. Success Metrics
54
- > [!NOTE] How we measure if the goals of this document are achieved.
55
-
56
- ## 11. Related Documents
57
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
58
-
59
- ## 12. Open Questions
60
- > [!NOTE] 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
- > [!NOTE] Summarize the product, system, or major epic requirement set at a high level.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Vision Statement
28
- > [!NOTE] A single, powerful sentence defining the ultimate end-state of the project.
29
-
30
- ## 8. Target Personas
31
- > [!NOTE] Specific user types (e.g., Admin, Guest) to give the team empathy.
32
-
33
- ## 9. Core Business Value
34
- > [!NOTE] The primary ROI, problem being solved, or operational improvement. Why does this project matter now?
35
-
36
- ## 10. User Journeys & App Flow
37
- > [!NOTE] 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
- > [!NOTE] Step-by-step logic flows for individual features. Use mermaid flowcharts to map complex feature logic.
49
-
50
- ## 12. Functional Requirements
51
- > [!NOTE] Detailed list of functional capabilities.
52
-
53
- ## 13. Non-Functional Requirements
54
- > [!NOTE] Reliability, performance, security, compliance, or UX expectations.
55
-
56
- ## 14. Acceptance Criteria
57
- > [!NOTE] Specific criteria to verify the requirements are met.
58
-
59
- ## 15. External Dependencies & Partners
60
- > [!NOTE] Third-party vendors and manual bottlenecks.
61
-
62
- ## 16. Success Metrics
63
- > [!NOTE] How we measure if the goals of this document are achieved.
64
-
65
- ## 17. Related Documents
66
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
67
-
68
- ## 18. Open Questions
69
- > [!NOTE] 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
- > [!NOTE] 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
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Current State
28
- > [!NOTE] Summarize the current implementation state, maturity, and major constraints.
29
-
30
- ## 8. Recent Accomplishments
31
- > [!NOTE] What was finished since the last update.
32
-
33
- ## 9. Upcoming Focus
34
- > [!NOTE] What the team is tackling next week/month.
35
-
36
- ## 10. Key Metrics Health
37
- > [!NOTE] 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
- > [!NOTE] Active and upcoming epics.
46
-
47
- ## 13. Risks / Blockers
48
- > [!NOTE] Immediate blockers holding up progress.
49
-
50
- ## 14. Success Metrics
51
- > [!NOTE] How we measure if the goals of this document are achieved.
52
-
53
- ## 15. Related Documents
54
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
55
-
56
- ## 16. Open Questions
57
- > [!NOTE] 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
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Local Development Loop
28
- > [!NOTE] How to spin up and iterate.
29
-
30
- ## 8. Branching Strategy
31
- > [!NOTE] 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
- > [!NOTE] Required approvers, templates, and conventions.
48
-
49
- ## 10. Issue Tracking & Triage
50
- > [!NOTE] How bugs and features are logged.
51
-
52
- ## 11. Success Metrics
53
- > [!NOTE] How we measure if the goals of this document are achieved.
54
-
55
- ## 12. Related Documents
56
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
57
-
58
- ## 13. Open Questions
59
- > [!NOTE] 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
- > [!NOTE] Explain how to set up, run, and orient a new contributor or operator in this repository.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Prerequisites
28
- > [!NOTE] 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
- > [!NOTE] Detailed steps for install, environment bootstrap, and local run.
38
-
39
- ## 10. Verification
40
- > [!NOTE] First validation command and where to find deeper testing guidance (e.g., `testing.md`).
41
-
42
- ## 11. Troubleshooting
43
- > [!NOTE] List known setup issues and their solutions.
44
-
45
- ## 12. Success Metrics
46
- > [!NOTE] How we measure if the goals of this document are achieved.
47
-
48
- ## 13. Related Documents
49
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
50
-
51
- ## 14. Open Questions
52
- > [!NOTE] Any unresolved questions or assumptions. Can be empty.
@@ -1,66 +0,0 @@
1
- # Index
2
-
3
- Last update: YYYY-MM-DD
4
-
5
- Status: [Proposed | Draft | Live | Deprecated | Archived]
6
-
7
- ---
8
-
9
- ## 1. Description
10
- > [!NOTE] Use this index to list the optional and conditional regular project docs that are active for a repository. The always-required core docs are defined by the contract and do not need registry entries to exist. This index is the authoritative registry for optional and conditional regular docs; starter template files are recommended references, not the activation mechanism.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. How to Use This Documentation
28
- > [!NOTE] A guide for new developers on where to start reading.
29
-
30
- ## 8. Documentation Ownership
31
- > [!NOTE] Who is responsible for keeping specific files up to date (e.g., "Backend team owns `api-contract.md`").
32
-
33
- ## 9. Foundational Required Docs
34
- - `prd.md`
35
- - `architecture.md`
36
- - `testing.md`
37
- - `workflow.md`
38
- - `status.md`
39
-
40
- ## 10. Optional And Conditional Docs
41
- | File | Purpose | Status | Owner | Creation trigger |
42
- | --- | --- | --- | --- | --- |
43
- | `changelog.md` | Release or milestone change history | conditional | TBD | When changes need release or milestone tracking |
44
- | `getting-started.md` | Setup, onboarding, and first-run guidance | conditional | TBD | When setup or onboarding needs a dedicated owner doc |
45
- | `feature-inventory.md` | Detailed feature catalog | conditional | TBD | When the feature surface is large enough to need inventory-level tracking |
46
- | `production-runbook.md` | Release, rollback, smoke-check, and recovery guidance | conditional | TBD | Before production operation needs a dedicated runbook |
47
- | `phases/index.md` | Multi-phase planning or epic registry | conditional | TBD | When roadmap work needs explicit phase tracking |
48
- | `YOUR_NEW_DOC.md` | State the purpose of the next optional regular doc here | conditional | TBD | State the creation trigger for the next optional regular doc here |
49
-
50
- > [!NOTE] Use status values such as `active`, `conditional`, `deprecated`, or `archived`. Add a new row in the `## 10. Optional And Conditional Docs` table above for each additional optional regular doc type that the repo activates.
51
-
52
- ## 11. Registry Rules
53
- - Add a new row in the `## 10. Optional And Conditional Docs` table above when an optional or conditional regular doc becomes part of the repo's active documentation set.
54
- - A row in this index activates a known optional doc type for bootstrap, refresh, and parity behavior.
55
- - If no starter template file exists for a listed doc type, use the stable headings or ownership rules defined in the contract.
56
- - Keep this index aligned with the files that actually exist under `docs/project-docs/`.
57
- - If a listed doc is deprecated or archived, update its status rather than silently removing its history.
58
-
59
- ## 12. Success Metrics
60
- > [!NOTE] How we measure if the goals of this document are achieved.
61
-
62
- ## 13. Related Documents
63
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
64
-
65
- ## 14. Open Questions
66
- > [!NOTE] 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
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Pipeline Architecture
28
- > [!NOTE] 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
- > [!NOTE] Compilation, bundling, and artifact generation.
39
-
40
- ## 9. Testing & Quality Gates
41
- > [!NOTE] Automated tests, linting, and security scans.
42
-
43
- ## 10. Deployment Environments
44
- > [!NOTE] Staging, UAT, and Production definitions.
45
-
46
- ## 11. Secrets & Environment Variables
47
- > [!NOTE] Required credentials (stored securely).
48
-
49
- ## 12. Success Metrics
50
- > [!NOTE] How we measure if the goals of this document are achieved.
51
-
52
- ## 13. Related Documents
53
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
54
-
55
- ## 14. Open Questions
56
- > [!NOTE] 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
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Data Privacy (GDPR / CCPA)
28
- > [!NOTE] PII handling and user consent.
29
-
30
- ## 8. Data Retention Policy
31
- > [!NOTE] How long logs and backups are kept before deletion.
32
-
33
- ## 9. Audit Logging
34
- > [!NOTE] Tracking who modified what, and when.
35
-
36
- ## 10. Legal Disclaimers & Terms
37
- > [!NOTE] Required user agreements and copyright notices.
38
-
39
- ## 11. Success Metrics
40
- > [!NOTE] How we measure if the goals of this document are achieved.
41
-
42
- ## 12. Related Documents
43
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
44
-
45
- ## 13. Open Questions
46
- > [!NOTE] Any unresolved questions or assumptions. Can be empty.
@@ -1,46 +0,0 @@
1
- # Governance
2
-
3
- Last update: YYYY-MM-DD
4
-
5
- Status: [Proposed | Draft | Live | Deprecated | Archived]
6
-
7
- ---
8
-
9
- ## 1. Description
10
- > [!NOTE] Briefly describe the purpose of this document and what it contains.
11
-
12
- ## 2. Important
13
- > [!NOTE] Notes of important findings or critical constraints. Can be empty.
14
-
15
- ## 3. Table of Contents
16
- > [!NOTE] TOC goes here.
17
-
18
- ## 4. Scope
19
- > [!NOTE] The boundaries of what this document covers.
20
-
21
- ## 5. Goals
22
- > [!NOTE] What we aim to achieve with this specific document.
23
-
24
- ## 6. Non Goals
25
- > [!NOTE] What is explicitly excluded from the scope of this document.
26
-
27
- ## 7. Versioning Policy (SemVer)
28
- > [!NOTE] Rules for major, minor, and patch bumps.
29
-
30
- ## 8. Release Cadence
31
- > [!NOTE] Scheduled deploy windows (e.g., every Tuesday).
32
-
33
- ## 9. Code Ownership & Maintainers
34
- > [!NOTE] Who is responsible for which modules.
35
-
36
- ## 10. Contribution Guidelines
37
- > [!NOTE] Rules for external or cross-team PRs.
38
-
39
- ## 11. Success Metrics
40
- > [!NOTE] How we measure if the goals of this document are achieved.
41
-
42
- ## 12. Related Documents
43
- > [!NOTE] [Link to related document](path) - Short brief note about why it's related.
44
-
45
- ## 13. Open Questions
46
- > [!NOTE] Any unresolved questions or assumptions. Can be empty.