@sallmarta/eye-hate-agent 1.0.1 → 1.0.3

package/docs/templates/project-docs-template/foundation/status.md

@@ -0,0 +1,57 @@
+# Status
+
+Last update: YYYY-MM-DD
+
+Status: [Proposed | Draft | Live | Deprecated | Archived]
+
+---
+
+## 1. Description
+Briefly describe the purpose of this document and what it contains. (Note: This dashboard is updated automatically by the EHA agent).
+
+## 2. Important
+Notes of important findings or critical constraints. Can be empty.
+
+## 3. Table of Contents
+[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)]
+
+## 4. Scope
+The boundaries of what this document covers.
+
+## 5. Goals
+What we aim to achieve with this specific document.
+
+## 6. Non Goals
+What is explicitly excluded from the scope of this document.
+
+## 7. Current State
+Summarize the current implementation state, maturity, and major constraints.
+
+## 8. Recent Accomplishments
+What was finished since the last update.
+
+## 9. Upcoming Focus
+What the team is tackling next week/month.
+
+## 10. Key Metrics Health
+Live data on project health (e.g., "Test Coverage: 85%", "Open Bugs: 12").
+
+## 11. Roadmap
+| Workstream | Status | Notes |
+| --- | --- | --- |
+| TBD | Planned | |
+
+## 12. Epics
+Active and upcoming epics.
+
+## 13. Risks / Blockers
+Immediate blockers holding up progress.
+
+## 14. Success Metrics
+How we measure if the goals of this document are achieved.
+
+## 15. Related Documents
+[Link to related document](path) - Short brief note about why it's related.
+
+## 16. Open Questions
+Any unresolved questions or assumptions. Can be empty.

package/docs/templates/project-docs-template/foundation/workflow.md

@@ -0,0 +1,59 @@
+# Workflow
+
+Last update: YYYY-MM-DD
+
+Status: [Proposed | Draft | Live | Deprecated | Archived]
+
+---
+
+## 1. Description
+Briefly describe the purpose of this document and what it contains.
+
+## 2. Important
+Notes of important findings or critical constraints. Can be empty.
+
+## 3. Table of Contents
+[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)]
+
+## 4. Scope
+The boundaries of what this document covers.
+
+## 5. Goals
+What we aim to achieve with this specific document.
+
+## 6. Non Goals
+What is explicitly excluded from the scope of this document.
+
+## 7. Local Development Loop
+How to spin up and iterate.
+
+## 8. Branching Strategy
+GitFlow, Trunk-based, or custom rules. Diagram of branching logic is preferred. Use mermaid.
+
+```mermaid
+gitGraph
+    commit
+    branch develop
+    checkout develop
+    commit
+    branch feature
+    checkout feature
+    commit
+    checkout develop
+    merge feature
+```
+
+## 9. PR & Code Review Process
+Required approvers, templates, and conventions.
+
+## 10. Issue Tracking & Triage
+How bugs and features are logged.
+
+## 11. Success Metrics
+How we measure if the goals of this document are achieved.
+
+## 12. Related Documents
+[Link to related document](path) - Short brief note about why it's related.
+
+## 13. Open Questions
+Any unresolved questions or assumptions. Can be empty.

package/docs/templates/project-docs-template/getting-started.md

@@ -0,0 +1,52 @@
+# Getting Started
+
+Last update: YYYY-MM-DD
+
+Status: [Proposed | Draft | Live | Deprecated | Archived]
+
+---
+
+## 1. Description
+Explain how to set up, run, and orient a new contributor or operator in this repository.
+
+## 2. Important
+Notes of important findings or critical constraints. Can be empty.
+
+## 3. Table of Contents
+[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)]
+
+## 4. Scope
+The boundaries of what this document covers.
+
+## 5. Goals
+What we aim to achieve with this specific document.
+
+## 6. Non Goals
+What is explicitly excluded from the scope of this document.
+
+## 7. Prerequisites
+Required tools, accounts, credentials, environment variables, or secrets handling.
+
+## 8. First Steps
+1. Clone or open the repository.
+2. Install dependencies or required tools.
+3. Configure local environment values.
+4. Run the standard startup or verification commands.
+
+## 9. Local Setup
+Detailed steps for install, environment bootstrap, and local run.
+
+## 10. Verification
+First validation command and where to find deeper testing guidance (e.g., `testing.md`).
+
+## 11. Troubleshooting
+List known setup issues and their solutions.
+
+## 12. Success Metrics
+How we measure if the goals of this document are achieved.
+
+## 13. Related Documents
+[Link to related document](path) - Short brief note about why it's related.
+
+## 14. Open Questions
+Any unresolved questions or assumptions. Can be empty.

package/docs/{vibes → templates}/project-docs-template/index.md

@@ -7,28 +7,28 @@ Status: [Proposed | Draft | Live | Deprecated | Archived]
 ---
 
 ## 1. Description
-> [!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.
+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.
 
 ## 2. Important
-> [!NOTE] Notes of important findings or critical constraints. Can be empty.
+Notes of important findings or critical constraints. Can be empty.
 
 ## 3. Table of Contents
-> [!NOTE] TOC goes here.
+[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)]
 
 ## 4. Scope
-> [!NOTE] The boundaries of what this document covers.
+The boundaries of what this document covers.
 
 ## 5. Goals
-> [!NOTE] What we aim to achieve with this specific document.
+What we aim to achieve with this specific document.
 
 ## 6. Non Goals
-> [!NOTE] What is explicitly excluded from the scope of this document.
+What is explicitly excluded from the scope of this document.
 
 ## 7. How to Use This Documentation
-> [!NOTE] A guide for new developers on where to start reading.
+A guide for new developers on where to start reading.
 
 ## 8. Documentation Ownership
-> [!NOTE] Who is responsible for keeping specific files up to date (e.g., "Backend team owns `api-contract.md`").
+Who is responsible for keeping specific files up to date (e.g., "Backend team owns `api-contract.md`").
 
 ## 9. Foundational Required Docs
 - `prd.md`
@@ -47,7 +47,7 @@ Status: [Proposed | Draft | Live | Deprecated | Archived]
 | `phases/index.md` | Multi-phase planning or epic registry | conditional | TBD | When roadmap work needs explicit phase tracking |
 | `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 |
 
-> [!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.
+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.
 
 ## 11. Registry Rules
 - 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.
@@ -57,10 +57,10 @@ Status: [Proposed | Draft | Live | Deprecated | Archived]
 - If a listed doc is deprecated or archived, update its status rather than silently removing its history.
 
 ## 12. Success Metrics
-> [!NOTE] How we measure if the goals of this document are achieved.
+How we measure if the goals of this document are achieved.
 
 ## 13. Related Documents
-> [!NOTE] [Link to related document](path) - Short brief note about why it's related.
+[Link to related document](path) - Short brief note about why it's related.
 
 ## 14. Open Questions
-> [!NOTE] Any unresolved questions or assumptions. Can be empty.
+Any unresolved questions or assumptions. Can be empty.

package/docs/templates/project-docs-template/operations/ci-cd.md

@@ -0,0 +1,56 @@
+# CI/CD Configuration
+
+Last update: YYYY-MM-DD
+
+Status: [Proposed | Draft | Live | Deprecated | Archived]
+
+---
+
+## 1. Description
+Briefly describe the purpose of this document and what it contains.
+
+## 2. Important
+Notes of important findings or critical constraints. Can be empty.
+
+## 3. Table of Contents
+[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)]
+
+## 4. Scope
+The boundaries of what this document covers.
+
+## 5. Goals
+What we aim to achieve with this specific document.
+
+## 6. Non Goals
+What is explicitly excluded from the scope of this document.
+
+## 7. Pipeline Architecture
+Overview of the branching and deployment flow. Flowcharts are preferred. Use mermaid.
+
+```mermaid
+graph LR
+    A[Commit] --> B[Build]
+    B --> C[Test]
+    C --> D[Deploy]
+```
+
+## 8. Build Steps
+Compilation, bundling, and artifact generation.
+
+## 9. Testing & Quality Gates
+Automated tests, linting, and security scans.
+
+## 10. Deployment Environments
+Staging, UAT, and Production definitions.
+
+## 11. Secrets & Environment Variables
+Required credentials (stored securely).
+
+## 12. Success Metrics
+How we measure if the goals of this document are achieved.
+
+## 13. Related Documents
+[Link to related document](path) - Short brief note about why it's related.
+
+## 14. Open Questions
+Any unresolved questions or assumptions. Can be empty.

package/docs/templates/project-docs-template/operations/compliance.md

@@ -0,0 +1,46 @@
+# Compliance
+
+Last update: YYYY-MM-DD
+
+Status: [Proposed | Draft | Live | Deprecated | Archived]
+
+---
+
+## 1. Description
+Briefly describe the purpose of this document and what it contains.
+
+## 2. Important
+Notes of important findings or critical constraints. Can be empty.
+
+## 3. Table of Contents
+[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)]
+
+## 4. Scope
+The boundaries of what this document covers.
+
+## 5. Goals
+What we aim to achieve with this specific document.
+
+## 6. Non Goals
+What is explicitly excluded from the scope of this document.
+
+## 7. Data Privacy (GDPR / CCPA)
+PII handling and user consent.
+
+## 8. Data Retention Policy
+How long logs and backups are kept before deletion.
+
+## 9. Audit Logging
+Tracking who modified what, and when.
+
+## 10. Legal Disclaimers & Terms
+Required user agreements and copyright notices.
+
+## 11. Success Metrics
+How we measure if the goals of this document are achieved.
+
+## 12. Related Documents
+[Link to related document](path) - Short brief note about why it's related.
+
+## 13. Open Questions
+Any unresolved questions or assumptions. Can be empty.

package/docs/templates/project-docs-template/operations/governance.md

@@ -0,0 +1,46 @@
+# Governance
+
+Last update: YYYY-MM-DD
+
+Status: [Proposed | Draft | Live | Deprecated | Archived]
+
+---
+
+## 1. Description
+Briefly describe the purpose of this document and what it contains.
+
+## 2. Important
+Notes of important findings or critical constraints. Can be empty.
+
+## 3. Table of Contents
+[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)]
+
+## 4. Scope
+The boundaries of what this document covers.
+
+## 5. Goals
+What we aim to achieve with this specific document.
+
+## 6. Non Goals
+What is explicitly excluded from the scope of this document.
+
+## 7. Versioning Policy (SemVer)
+Rules for major, minor, and patch bumps.
+
+## 8. Release Cadence
+Scheduled deploy windows (e.g., every Tuesday).
+
+## 9. Code Ownership & Maintainers
+Who is responsible for which modules.
+
+## 10. Contribution Guidelines
+Rules for external or cross-team PRs.
+
+## 11. Success Metrics
+How we measure if the goals of this document are achieved.
+
+## 12. Related Documents
+[Link to related document](path) - Short brief note about why it's related.
+
+## 13. Open Questions
+Any unresolved questions or assumptions. Can be empty.

package/docs/templates/project-docs-template/operations/observability.md

@@ -0,0 +1,53 @@
+# Observability & Telemetry
+
+Last update: YYYY-MM-DD
+
+Status: [Proposed | Draft | Live | Deprecated | Archived]
+
+---
+
+## 1. Description
+Briefly describe the purpose of this document and what it contains.
+
+## 2. Important
+Notes of important findings or critical constraints. Can be empty.
+
+## 3. Table of Contents
+[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)]
+
+## 4. Scope
+The boundaries of what this document covers.
+
+## 5. Goals
+What we aim to achieve with this specific document.
+
+## 6. Non Goals
+What is explicitly excluded from the scope of this document.
+
+## 7. Logging Strategy & Levels
+Formatting (e.g., JSON) and severity rules (Info/Warn/Error).
+
+## 8. Metrics & Dashboards
+Key Performance Indicators (latency, error rates).
+
+## 9. Distributed Tracing
+Request IDs and flow mapping across microservices.
+
+## 10. Alerting Rules & Thresholds
+Conditions that trigger on-call pages. Flowcharts are preferred. Use mermaid.
+
+```mermaid
+graph TD
+    A[Alert Triggered] --> B{Severity Level}
+    B -- High --> C[Page On-Call]
+    B -- Low --> D[Log to Ticket]
+```
+
+## 11. Success Metrics
+How we measure if the goals of this document are achieved.
+
+## 12. Related Documents
+[Link to related document](path) - Short brief note about why it's related.
+
+## 13. Open Questions
+Any unresolved questions or assumptions. Can be empty.

package/docs/templates/project-docs-template/operations/production-runbook.md

@@ -0,0 +1,62 @@
+# Production Runbook
+
+Last update: YYYY-MM-DD
+
+Status: [Proposed | Draft | Live | Deprecated | Archived]
+
+---
+
+## 1. Description
+Describe what this runbook covers and which environment or service it applies to.
+
+## 2. Important
+Notes of important findings or critical constraints. Can be empty.
+
+## 3. Table of Contents
+[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)]
+
+## 4. Scope
+The boundaries of what this document covers.
+
+## 5. Goals
+What we aim to achieve with this specific document.
+
+## 6. Non Goals
+What is explicitly excluded from the scope of this document.
+
+## 7. Environment Overview
+Production environment summary. Key dependencies or infrastructure notes.
+
+## 8. Prerequisites and Access
+- Required tools
+- Required permissions or credentials
+- Safety checks before making changes
+
+## 9. Release / Deployment Procedure
+1. Step 1
+2. Step 2
+3. Step 3
+
+## 10. Verification / Smoke Checks
+Checks to run to ensure deployment is healthy.
+
+## 11. Rollback / Recovery
+Steps to recover from a failed deployment. Flowcharts are preferred. Use mermaid.
+
+```mermaid
+graph TD
+    A[Failure Detected] --> B[Trigger Rollback]
+    B --> C[Verify Previous State]
+```
+
+## 12. Operational Notes
+Known gotchas.
+
+## 13. Success Metrics
+How we measure if the goals of this document are achieved.
+
+## 14. Related Documents
+[Link to related document](path) - Short brief note about why it's related.
+
+## 15. Open Questions
+Any unresolved questions or assumptions. Can be empty.

package/docs/templates/project-docs-template/operations/security.md

@@ -0,0 +1,49 @@
+# Security
+
+Last update: YYYY-MM-DD
+
+Status: [Proposed | Draft | Live | Deprecated | Archived]
+
+---
+
+## 1. Description
+Briefly describe the purpose of this document and what it contains.
+
+## 2. Important
+Notes of important findings or critical constraints. Can be empty.
+
+## 3. Table of Contents
+[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)]
+
+## 4. Scope
+The boundaries of what this document covers.
+
+## 5. Goals
+What we aim to achieve with this specific document.
+
+## 6. Non Goals
+What is explicitly excluded from the scope of this document.
+
+## 7. Security Objectives
+Primary assets to protect.
+
+## 8. Identified Threats & Vectors
+Known vulnerabilities (e.g., injection, XSS, DDOS).
+
+## 9. Mitigation Strategies
+How the architecture neutralizes the threats.
+
+## 10. Access Control (RBAC)
+Roles, permissions, and session management.
+
+## 11. Data Encryption (At-Rest / In-Transit)
+Algorithms and key management.
+
+## 12. Success Metrics
+How we measure if the goals of this document are achieved.
+
+## 13. Related Documents
+[Link to related document](path) - Short brief note about why it's related.
+
+## 14. Open Questions
+Any unresolved questions or assumptions. Can be empty.

package/docs/templates/project-docs-template/technical/api-contract.md

@@ -0,0 +1,49 @@
+# API Contract
+
+Last update: YYYY-MM-DD
+
+Status: [Proposed | Draft | Live | Deprecated | Archived]
+
+---
+
+## 1. Description
+Briefly describe the purpose of this document and what it contains.
+
+## 2. Important
+Notes of important findings or critical constraints. Can be empty.
+
+## 3. Table of Contents
+[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)]
+
+## 4. Scope
+The boundaries of what this document covers.
+
+## 5. Goals
+What we aim to achieve with this specific document.
+
+## 6. Non Goals
+What is explicitly excluded from the scope of this document.
+
+## 7. Base URL & Authentication
+Core connection details and token requirements.
+
+## 8. Standard Request/Response Format
+The expected shape of data (e.g., standard JSON wrapper).
+
+## 9. Endpoints (REST / GraphQL)
+Specific routes, methods, payloads, and responses.
+
+## 10. Webhooks & Events
+Outbound data events pushed to external systems.
+
+## 11. Rate Limiting & Constraints
+Throttling rules and payload size limits.
+
+## 12. Success Metrics
+How we measure if the goals of this document are achieved.
+
+## 13. Related Documents
+[Link to related document](path) - Short brief note about why it's related.
+
+## 14. Open Questions
+Any unresolved questions or assumptions. Can be empty.

package/docs/templates/project-docs-template/technical/database.md

@@ -0,0 +1,59 @@
+# Database Schema
+
+Last update: YYYY-MM-DD
+
+Status: [Proposed | Draft | Live | Deprecated | Archived]
+
+---
+
+## 1. Description
+Briefly describe the purpose of this document and what it contains.
+
+## 2. Important
+Notes of important findings or critical constraints. Can be empty.
+
+## 3. Table of Contents
+[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)]
+
+## 4. Scope
+The boundaries of what this document covers.
+
+## 5. Goals
+What we aim to achieve with this specific document.
+
+## 6. Non Goals
+What is explicitly excluded from the scope of this document.
+
+## 7. Database Architecture
+Type of DB (SQL/NoSQL) and clustering details.
+
+## 8. Entity Relationship Diagram (ERD)
+Visual or text-based map of table relationships. ERDs are preferred. Use mermaid.
+
+```mermaid
+erDiagram
+    CUSTOMER ||--o{ ORDER : places
+    ORDER ||--|{ LINE-ITEM : contains
+    CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
+```
+
+## 9. Schema Definitions (Tables/Collections)
+Specific columns, types, and constraints.
+
+## 10. Indexes & Performance
+Keys required for fast lookups.
+
+## 11. Migration Strategy
+How schema changes are versioned and deployed.
+
+## 12. Data Dictionary
+Single source of truth for business definitions. Define what key domain terms actually mean (e.g., "An *Active User* is someone who logged in within 30 days, excluding admins").
+
+## 13. Success Metrics
+How we measure if the goals of this document are achieved.
+
+## 14. Related Documents
+[Link to related document](path) - Short brief note about why it's related.
+
+## 15. Open Questions
+Any unresolved questions or assumptions. Can be empty.