# thorcollective/hearth architecture

> Architecture diagram of the GitHub repository thorcollective/hearth, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/thorcollective/hearth
- Repository: https://github.com/thorcollective/hearth

## Overview

##### Main Components
- Hunt Categories:
- Flames (Hypothesis-driven hunts)
- Embers (Environment baselining and exploratory analysis)
- Alchemy (Model-assisted and algorithmic approaches)
- Supporting/Collaboration Areas:
- Forge: A space for early-stage hunt ideas and development.
- Kindling: Contains templates, guides (e.g., Hunt-Generation, Hunt-Review), and additional resources.
- Keepers: Guidelines, contribution process documentation, review-process details, and community standards.
- Assets: Contains the images, logos, and other static resources used in the repository.
- GitHub Configurations: The .github directory holds issue templates and workflows for tasks like labeling issues and static code analysis, showcasing integration with CI/CD pipelines to support contributions.

##### Interactions and Flows
- Contribution Flow:
- Users submit hunt ideas (via issues or pull requests) through the GitHub submission system.
- The GitHub workflows (defined under .github/workflows) automatically process submissions (for example, labeling or static checks).
- Reviewed submissions eventually become part of one of the hunt type directories (Flames, Embers, or Alchemy) or are iterated further in Forge.
- The review and refinement process is detailed in the Keepers and Kindling directories.
- Organizational Flow:

##### Architectural Patterns and Design Principles
- Separation of Concerns: The repository is neatly divided into directories, each with a clear responsibility—content focus (the three hunt categories), early development (Forge), resources/templates (Kindling), and governance (Keepers).
- Workflow Automation: Highlight the integration with GitHub Actions (issue-labeler and static analysis workflows) which help automate part of the review and contribution process.
- Community-Centric Design: The structure emphasizes collaboration, documentation, and feedback channels.

## Diagram (Mermaid)

```mermaid
graph TD
    %% Nodes
    US["User Submission"]:::process
    GA[".github (Automation)"]:::automation
    CRP["Contribution & Review Process"]:::process
    A["Assets\n(Static Assets)"]:::content

    %% Subgraph for Hunt Categories
    subgraph "Hunt Categories"
        FL["Flames\n(Hypothesis-driven hunts)"]:::content
        EM["Embers\n(Environment baselining & exploratory analysis)"]:::content
        AL["Alchemy\n(Model-assisted & algorithmic hunts)"]:::content
    end

    %% Subgraph for Support/Process Areas
    subgraph "Support/Process Areas"
        FO["Forge\n(Early-stage Hunt Ideas)"]:::support
        KI["Kindling\n(Templates, Guides & Resources)"]:::support
        KE["Keepers\n(Contribution & Review Documentation)"]:::support
    end

    %% Relationships
    US -->|"submits"| GA
    GA -->|"automated checks"| CRP
    CRP -->|"assigns ideas"| FL
    CRP -->|"assigns ideas"| EM
    CRP -->|"assigns ideas"| AL
    CRP -->|"refinement"| FO
    CRP -->|"provides guidelines"| KI
    CRP -->|"review process"| KE
    A -->|"provides assets to"| FL
    A -->|"provides assets to"| EM
    A -->|"provides assets to"| AL

    %% Click Events
    click FL "https://github.com/thorcollective/hearth/tree/main/Flames"
    click EM "https://github.com/thorcollective/hearth/tree/main/Embers"
    click AL "https://github.com/thorcollective/hearth/tree/main/Alchemy"
    click FO "https://github.com/thorcollective/hearth/blob/main/Forge/Forge.md"
    click KI "https://github.com/thorcollective/hearth/blob/main/Kindling/Hunt-Template.md"
    click KE "https://github.com/thorcollective/hearth/blob/main/Keepers/Contributing.md"
    click A "https://github.com/thorcollective/hearth/tree/main/Assets"
    click GA "https://github.com/thorcollective/hearth/blob/main/.github"
    
    %% Styles
    classDef process fill:#FFF9C4,stroke:#FBC02D,stroke-width:2px;
    classDef content fill:#B3E5FC,stroke:#0277BD,stroke-width:2px;
    classDef support fill:#C8E6C9,stroke:#388E3C,stroke-width:2px;
    classDef automation fill:#D1C4E9,stroke:#673AB7,stroke-width:2px;
```
