@ruaruababa/vibe-kit 1.0.0

package/skills/c4-code/SKILL.md

@@ -0,0 +1,244 @@
+---
+name: c4-code
+description: Expert C4 Code-level documentation specialist. Analyzes code
+  directories to create comprehensive C4 code-level documentation including
+  function signatures, arguments, dependencies, and code structure. Use when
+  documenting code at the lowest C4 level for individual directories and code
+  modules.
+metadata:
+  model: haiku
+---
+
+# C4 Code Level: [Directory Name]
+
+## Use this skill when
+
+- Working on c4 code level: [directory name] tasks or workflows
+- Needing guidance, best practices, or checklists for c4 code level: [directory name]
+
+## Do not use this skill when
+
+- The task is unrelated to c4 code level: [directory name]
+- You need a different domain or tool outside this scope
+
+## Instructions
+
+- Clarify goals, constraints, and required inputs.
+- Apply relevant best practices and validate outcomes.
+- Provide actionable steps and verification.
+- If detailed examples are required, open `resources/implementation-playbook.md`.
+
+## Overview
+
+- **Name**: [Descriptive name for this code directory]
+- **Description**: [Short description of what this code does]
+- **Location**: [Link to actual directory path]
+- **Language**: [Primary programming language(s)]
+- **Purpose**: [What this code accomplishes]
+
+## Code Elements
+
+### Functions/Methods
+
+- `functionName(param1: Type, param2: Type): ReturnType`
+  - Description: [What this function does]
+  - Location: [file path:line number]
+  - Dependencies: [what this function depends on]
+
+### Classes/Modules
+
+- `ClassName`
+  - Description: [What this class does]
+  - Location: [file path]
+  - Methods: [list of methods]
+  - Dependencies: [what this class depends on]
+
+## Dependencies
+
+### Internal Dependencies
+
+- [List of internal code dependencies]
+
+### External Dependencies
+
+- [List of external libraries, frameworks, services]
+
+## Relationships
+
+Optional Mermaid diagrams for complex code structures. Choose the diagram type based on the programming paradigm. Code diagrams show the **internal structure of a single component**.
+
+### Object-Oriented Code (Classes, Interfaces)
+
+Use `classDiagram` for OOP code with classes, interfaces, and inheritance:
+
+```mermaid
+---
+title: Code Diagram for [Component Name]
+---
+classDiagram
+    namespace ComponentName {
+        class Class1 {
+            +attribute1 Type
+            +method1() ReturnType
+        }
+        class Class2 {
+            -privateAttr Type
+            +publicMethod() void
+        }
+        class Interface1 {
+            <<interface>>
+            +requiredMethod() ReturnType
+        }
+    }
+
+    Class1 ..|> Interface1 : implements
+    Class1 --> Class2 : uses
+```
+````
+
+### Functional/Procedural Code (Modules, Functions)
+
+For functional or procedural code, you have two options:
+
+**Option A: Module Structure Diagram** - Use `classDiagram` to show modules and their exported functions:
+
+```mermaid
+---
+title: Module Structure for [Component Name]
+---
+classDiagram
+    namespace DataProcessing {
+        class validators {
+            <<module>>
+            +validateInput(data) Result~Data, Error~
+            +validateSchema(schema, data) bool
+            +sanitize(input) string
+        }
+        class transformers {
+            <<module>>
+            +parseJSON(raw) Record
+            +normalize(data) NormalizedData
+            +aggregate(items) Summary
+        }
+        class io {
+            <<module>>
+            +readFile(path) string
+            +writeFile(path, content) void
+        }
+    }
+
+    transformers --> validators : uses
+    transformers --> io : reads from
+```
+
+**Option B: Data Flow Diagram** - Use `flowchart` to show function pipelines and data transformations:
+
+```mermaid
+---
+title: Data Pipeline for [Component Name]
+---
+flowchart LR
+    subgraph Input
+        A[readFile]
+    end
+    subgraph Transform
+        B[parseJSON]
+        C[validateInput]
+        D[normalize]
+        E[aggregate]
+    end
+    subgraph Output
+        F[writeFile]
+    end
+
+    A -->|raw string| B
+    B -->|parsed data| C
+    C -->|valid data| D
+    D -->|normalized| E
+    E -->|summary| F
+```
+
+**Option C: Function Dependency Graph** - Use `flowchart` to show which functions call which:
+
+```mermaid
+---
+title: Function Dependencies for [Component Name]
+---
+flowchart TB
+    subgraph Public API
+        processData[processData]
+        exportReport[exportReport]
+    end
+    subgraph Internal Functions
+        validate[validate]
+        transform[transform]
+        format[format]
+        cache[memoize]
+    end
+    subgraph Pure Utilities
+        compose[compose]
+        pipe[pipe]
+        curry[curry]
+    end
+
+    processData --> validate
+    processData --> transform
+    processData --> cache
+    transform --> compose
+    transform --> pipe
+    exportReport --> format
+    exportReport --> processData
+```
+
+### Choosing the Right Diagram
+
+| Code Style                       | Primary Diagram                  | When to Use                                             |
+| -------------------------------- | -------------------------------- | ------------------------------------------------------- |
+| OOP (classes, interfaces)        | `classDiagram`                   | Show inheritance, composition, interface implementation |
+| FP (pure functions, pipelines)   | `flowchart`                      | Show data transformations and function composition      |
+| FP (modules with exports)        | `classDiagram` with `<<module>>` | Show module structure and dependencies                  |
+| Procedural (structs + functions) | `classDiagram`                   | Show data structures and associated functions           |
+| Mixed                            | Combination                      | Use multiple diagrams if needed                         |
+
+**Note**: According to the [C4 model](https://c4model.com/diagrams), code diagrams are typically only created when needed for complex components. Most teams find system context and container diagrams sufficient. Choose the diagram type that best communicates the code structure regardless of paradigm.
+
+## Notes
+
+[Any additional context or important information]
+
+```
+
+## Example Interactions
+
+### Object-Oriented Codebases
+- "Analyze the src/api directory and create C4 Code-level documentation"
+- "Document the service layer code with complete class hierarchies and dependencies"
+- "Create C4 Code documentation showing interface implementations in the repository layer"
+
+### Functional/Procedural Codebases
+- "Document all functions in the authentication module with their signatures and data flow"
+- "Create a data pipeline diagram for the ETL transformers in src/pipeline"
+- "Analyze the utils directory and document all pure functions and their composition patterns"
+- "Document the Rust modules in src/handlers showing function dependencies"
+- "Create C4 Code documentation for the Elixir GenServer modules"
+
+### Mixed Paradigm
+- "Document the Go handlers package showing structs and their associated functions"
+- "Analyze the TypeScript codebase that mixes classes with functional utilities"
+
+## Key Distinctions
+- **vs C4-Component agent**: Focuses on individual code elements; Component agent synthesizes multiple code files into components
+- **vs C4-Container agent**: Documents code structure; Container agent maps components to deployment units
+- **vs C4-Context agent**: Provides code-level detail; Context agent creates high-level system diagrams
+
+## Output Examples
+When analyzing code, provide:
+- Complete function/method signatures with all parameters and return types
+- Clear descriptions of what each code element does
+- Links to actual source code locations
+- Complete dependency lists (internal and external)
+- Structured documentation following C4 Code-level template
+- Mermaid diagrams for complex code relationships when needed
+- Consistent naming and formatting across all code documentation
+
+```

package/skills/c4-component/SKILL.md

@@ -0,0 +1,153 @@
+---
+name: c4-component
+description: Expert C4 Component-level documentation specialist. Synthesizes C4
+  Code-level documentation into Component-level architecture, defining component
+  boundaries, interfaces, and relationships. Creates component diagrams and
+  documentation. Use when synthesizing code-level documentation into logical
+  components.
+metadata:
+  model: sonnet
+---
+
+# C4 Component Level: [Component Name]
+
+## Use this skill when
+
+- Working on c4 component level: [component name] tasks or workflows
+- Needing guidance, best practices, or checklists for c4 component level: [component name]
+
+## Do not use this skill when
+
+- The task is unrelated to c4 component level: [component name]
+- You need a different domain or tool outside this scope
+
+## Instructions
+
+- Clarify goals, constraints, and required inputs.
+- Apply relevant best practices and validate outcomes.
+- Provide actionable steps and verification.
+- If detailed examples are required, open `resources/implementation-playbook.md`.
+
+## Overview
+
+- **Name**: [Component name]
+- **Description**: [Short description of component purpose]
+- **Type**: [Component type: Application, Service, Library, etc.]
+- **Technology**: [Primary technologies used]
+
+## Purpose
+
+[Detailed description of what this component does and what problems it solves]
+
+## Software Features
+
+- [Feature 1]: [Description]
+- [Feature 2]: [Description]
+- [Feature 3]: [Description]
+
+## Code Elements
+
+This component contains the following code-level elements:
+
+- [c4-code-file-1.md](./c4-code-file-1.md) - [Description]
+- [c4-code-file-2.md](./c4-code-file-2.md) - [Description]
+
+## Interfaces
+
+### [Interface Name]
+
+- **Protocol**: [REST/GraphQL/gRPC/Events/etc.]
+- **Description**: [What this interface provides]
+- **Operations**:
+  - `operationName(params): ReturnType` - [Description]
+
+## Dependencies
+
+### Components Used
+
+- [Component Name]: [How it's used]
+
+### External Systems
+
+- [External System]: [How it's used]
+
+## Component Diagram
+
+Use proper Mermaid C4Component syntax. Component diagrams show components **within a single container**:
+
+```mermaid
+C4Component
+    title Component Diagram for [Container Name]
+
+    Container_Boundary(container, "Container Name") {
+        Component(component1, "Component 1", "Type", "Description")
+        Component(component2, "Component 2", "Type", "Description")
+        ComponentDb(component3, "Component 3", "Database", "Description")
+    }
+    Container_Ext(externalContainer, "External Container", "Description")
+    System_Ext(externalSystem, "External System", "Description")
+
+    Rel(component1, component2, "Uses")
+    Rel(component2, component3, "Reads from and writes to")
+    Rel(component1, externalContainer, "Uses", "API")
+    Rel(component2, externalSystem, "Uses", "API")
+```
+````
+
+**Key Principles** (from [c4model.com](https://c4model.com/diagrams/component)):
+
+- Show components **within a single container** (zoom into one container)
+- Focus on **logical components** and their responsibilities
+- Show **component interfaces** (what they expose)
+- Show how components **interact** with each other
+- Include **external dependencies** (other containers, external systems)
+
+````
+
+## Master Component Index Template
+
+```markdown
+# C4 Component Level: System Overview
+
+## System Components
+
+### [Component 1]
+- **Name**: [Component name]
+- **Description**: [Short description]
+- **Documentation**: [c4-component-name-1.md](./c4-component-name-1.md)
+
+### [Component 2]
+- **Name**: [Component name]
+- **Description**: [Short description]
+- **Documentation**: [c4-component-name-2.md](./c4-component-name-2.md)
+
+## Component Relationships
+[Mermaid diagram showing all components and their relationships]
+````
+
+## Example Interactions
+
+- "Synthesize all c4-code-\*.md files into logical components"
+- "Define component boundaries for the authentication and authorization code"
+- "Create component-level documentation for the API layer"
+- "Identify component interfaces and create component diagrams"
+- "Group database access code into components and document their relationships"
+
+## Key Distinctions
+
+- **vs C4-Code agent**: Synthesizes multiple code files into components; Code agent documents individual code elements
+- **vs C4-Container agent**: Focuses on logical grouping; Container agent maps components to deployment units
+- **vs C4-Context agent**: Provides component-level detail; Context agent creates high-level system diagrams
+
+## Output Examples
+
+When synthesizing components, provide:
+
+- Clear component boundaries with rationale
+- Descriptive component names and purposes
+- Comprehensive feature lists for each component
+- Complete interface documentation with protocols and operations
+- Links to all contained c4-code-\*.md files
+- Mermaid component diagrams showing relationships
+- Master component index with all components
+- Consistent documentation format across all components

package/skills/c4-container/SKILL.md

@@ -0,0 +1,171 @@
+---
+name: c4-container
+description: Expert C4 Container-level documentation specialist. Synthesizes
+  Component-level documentation into Container-level architecture, mapping
+  components to deployment units, documenting container interfaces as APIs, and
+  creating container diagrams. Use when synthesizing components into deployment
+  containers and documenting system deployment architecture.
+metadata:
+  model: sonnet
+---
+
+# C4 Container Level: System Deployment
+
+## Use this skill when
+
+- Working on c4 container level: system deployment tasks or workflows
+- Needing guidance, best practices, or checklists for c4 container level: system deployment
+
+## Do not use this skill when
+
+- The task is unrelated to c4 container level: system deployment
+- You need a different domain or tool outside this scope
+
+## Instructions
+
+- Clarify goals, constraints, and required inputs.
+- Apply relevant best practices and validate outcomes.
+- Provide actionable steps and verification.
+- If detailed examples are required, open `resources/implementation-playbook.md`.
+
+## Containers
+
+### [Container Name]
+
+- **Name**: [Container name]
+- **Description**: [Short description of container purpose and deployment]
+- **Type**: [Web Application, API, Database, Message Queue, etc.]
+- **Technology**: [Primary technologies: Node.js, Python, PostgreSQL, Redis, etc.]
+- **Deployment**: [Docker, Kubernetes, Cloud Service, etc.]
+
+## Purpose
+
+[Detailed description of what this container does and how it's deployed]
+
+## Components
+
+This container deploys the following components:
+
+- [Component Name]: [Description]
+  - Documentation: [c4-component-name.md](./c4-component-name.md)
+
+## Interfaces
+
+### [API/Interface Name]
+
+- **Protocol**: [REST/GraphQL/gRPC/Events/etc.]
+- **Description**: [What this interface provides]
+- **Specification**: [Link to OpenAPI/Swagger/API Spec file]
+- **Endpoints**:
+  - `GET /api/resource` - [Description]
+  - `POST /api/resource` - [Description]
+
+## Dependencies
+
+### Containers Used
+
+- [Container Name]: [How it's used, communication protocol]
+
+### External Systems
+
+- [External System]: [How it's used, integration type]
+
+## Infrastructure
+
+- **Deployment Config**: [Link to Dockerfile, K8s manifest, etc.]
+- **Scaling**: [Horizontal/vertical scaling strategy]
+- **Resources**: [CPU, memory, storage requirements]
+
+## Container Diagram
+
+Use proper Mermaid C4Container syntax:
+
+```mermaid
+C4Container
+    title Container Diagram for [System Name]
+
+    Person(user, "User", "Uses the system")
+    System_Boundary(system, "System Name") {
+        Container(webApp, "Web Application", "Spring Boot, Java", "Provides web interface")
+        Container(api, "API Application", "Node.js, Express", "Provides REST API")
+        ContainerDb(database, "Database", "PostgreSQL", "Stores data")
+        Container_Queue(messageQueue, "Message Queue", "RabbitMQ", "Handles async messaging")
+    }
+    System_Ext(external, "External System", "Third-party service")
+
+    Rel(user, webApp, "Uses", "HTTPS")
+    Rel(webApp, api, "Makes API calls to", "JSON/HTTPS")
+    Rel(api, database, "Reads from and writes to", "SQL")
+    Rel(api, messageQueue, "Publishes messages to")
+    Rel(api, external, "Uses", "API")
+```
+````
+
+**Key Principles** (from [c4model.com](https://c4model.com/diagrams/container)):
+
+- Show **high-level technology choices** (this is where technology details belong)
+- Show how **responsibilities are distributed** across containers
+- Include **container types**: Applications, Databases, Message Queues, File Systems, etc.
+- Show **communication protocols** between containers
+- Include **external systems** that containers interact with
+
+````
+
+## API Specification Template
+
+For each container API, create an OpenAPI/Swagger specification:
+
+```yaml
+openapi: 3.1.0
+info:
+  title: [Container Name] API
+  description: [API description]
+  version: 1.0.0
+servers:
+  - url: https://api.example.com
+    description: Production server
+paths:
+  /api/resource:
+    get:
+      summary: [Operation summary]
+      description: [Operation description]
+      parameters:
+        - name: param1
+          in: query
+          schema:
+            type: string
+      responses:
+        '200':
+          description: [Response description]
+          content:
+            application/json:
+              schema:
+                type: object
+````
+
+## Example Interactions
+
+- "Synthesize all components into containers based on deployment definitions"
+- "Map the API components to containers and document their APIs as OpenAPI specs"
+- "Create container-level documentation for the microservices architecture"
+- "Document container interfaces as Swagger/OpenAPI specifications"
+- "Analyze Kubernetes manifests and create container documentation"
+
+## Key Distinctions
+
+- **vs C4-Component agent**: Maps components to deployment units; Component agent focuses on logical grouping
+- **vs C4-Context agent**: Provides container-level detail; Context agent creates high-level system diagrams
+- **vs C4-Code agent**: Focuses on deployment architecture; Code agent documents individual code elements
+
+## Output Examples
+
+When synthesizing containers, provide:
+
+- Clear container boundaries with deployment rationale
+- Descriptive container names and deployment characteristics
+- Complete API documentation with OpenAPI/Swagger specifications
+- Links to all contained components
+- Mermaid container diagrams showing deployment architecture
+- Links to deployment configurations (Dockerfiles, K8s manifests, etc.)
+- Infrastructure requirements and scaling considerations
+- Consistent documentation format across all containers