# bcdigschol/edi-technology architecture

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

- Interactive diagram: https://gitdiagram.com/bcdigschol/edi-technology
- Repository: https://github.com/bcdigschol/edi-technology

## Overview

##### Main Components
- Static Site Generator: Jekyll is the core engine that processes the content (in _pages, _layouts, and _includes) and configuration (_config.yml) to produce static HTML.
- Frontend Assets: The assets directory (with CSS, JS, images, and fonts) and configuration files such as tailwind.config.js and postcss.config.js show that Tailwind CSS (and further styling) is used for the front-end.
- Local Development Environment: Tools like Ruby (with bundler), Node (with npm dependencies), and the configuration instructions in the README highlight that developers use a dual environment for building and testing the site.
- CI/CD Pipeline: The .github directory (with workflow YAML files) indicates that GitHub Actions are used to build or deploy the site.
- Static Hosting/Deployment: Although not explicitly mentioned, the presence of a Jekyll workflow and hosting-related files (like 404.html) suggests the site might be deployed on GitHub Pages or a similar static hosting service.

##### Relationships and Interactions
- The Developer / Build Environment interacts with both Ruby (via Bundler) and Node (via npm) to manage dependencies.
- Jekyll takes content from _pages, _layouts, and _includes and combines it with configuration settings (_config.yml) to generate static HTML files.
- The assets (under assets/) are compiled (possibly via a build step with Tailwind and PostCSS) and linked in the templates.
- The GitHub workflows trigger builds and tests (if any), ensuring that changes are checked automatically before deployment.
- The final static output is then deployed/served to users, possibly via GitHub Pages.

##### Architectural Patterns
- Separation of Concerns: Content (e.g., Markdown files in _pages), Presentation (in _layouts and _includes), and styling (assets/) are clearly separated.
- Build Pipeline: The process moves from local development to automated build and deployment via CI workflows.

##### Relevant Technologies
- Jekyll (Ruby-based SSG), Ruby (bundler), Node (npm dependencies), Tailwind CSS, PostCSS, and GitHub Actions.
- Mention external tools referenced in the README, such as the TailPages setup by Harry Wang, which indicates that best practices for Jekyll combined with modern CSS frameworks are in place.

##### Final Advice
- Clarity: Each block should be clearly labeled (for example, “Content & Templates (_pages, _layouts, _includes)”, “Build Engine (Jekyll)”, “Static Assets (assets/, _sass)”, “CI/CD (GitHub Actions)”, and “Deployment (Static Hosting)”).
- External dependency labels (such as Ruby, Node, Tailwind) next to or within their respective build components.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Local Development Environment
    subgraph "Local Development Environment"
        Dev_Gemfile["Gemfile"]:::dev
        Dev_pkg["package.json"]:::dev
        Dev_readme["README.md"]:::dev
    end

    %% Build Process containing Jekyll Engine and Asset Pipeline
    subgraph "Build Process"
        subgraph "Jekyll Engine"
            J_config["_config.yml"]:::jekyll
            J_pages["_pages"]:::jekyll
            J_layouts["_layouts"]:::jekyll
            J_includes["_includes"]:::jekyll
        end
        subgraph "Asset Pipeline"
            A_assets["assets"]:::asset
            A_sass["_sass"]:::asset
            A_tailwind["tailwind.config.js"]:::asset
            A_postcss["postcss.config.js"]:::asset
        end
    end

    %% Combined Build Output Node
    Build_Output["Combined Build Output"]:::buildoutput

    %% CI/CD Pipeline
    CD_github["CI/CD Pipeline (GitHub Actions)"]:::cicd

    %% Static Hosting / Deployment
    subgraph "Static Hosting/Deployment"
        D_index["index.html"]:::deploy
        D_404["404.html"]:::deploy
    end

    %% Connections: Developer Environment triggers Build Process
    Dev_Gemfile -->|"triggers"| J_config
    Dev_Gemfile -->|"triggers"| A_assets
    Dev_pkg --- Dev_Gemfile
    Dev_readme --- Dev_Gemfile

    %% Internal flow within Jekyll Engine & Asset Pipeline
    J_config -->|"prepares"| J_pages
    J_pages -->|"structures"| J_layouts
    J_layouts -->|"assembles"| J_includes

    A_assets -->|"feeds"| A_sass
    A_sass -->|"configures"| A_tailwind
    A_tailwind -->|"processes"| A_postcss

    %% Merging build outputs from Jekyll Engine and Asset Pipeline
    J_includes -->|"generates"| Build_Output
    A_postcss -->|"compiles"| Build_Output

    %% CI/CD Pipeline process
    Build_Output -->|"build triggers"| CD_github

    %% Deployment Flow
    CD_github -->|"deploys to"| D_index
    CD_github -->|"deploys to"| D_404

    %% Click Events for Component Mappings
    click Dev_Gemfile "https://github.com/bcdigschol/edi-technology/tree/main/Gemfile"
    click Dev_pkg "https://github.com/bcdigschol/edi-technology/blob/main/package.json"
    click Dev_readme "https://github.com/bcdigschol/edi-technology/blob/main/README.md"
    click J_config "https://github.com/bcdigschol/edi-technology/blob/main/_config.yml"
    click J_pages "https://github.com/bcdigschol/edi-technology/tree/main/_pages"
    click J_layouts "https://github.com/bcdigschol/edi-technology/tree/main/_layouts"
    click J_includes "https://github.com/bcdigschol/edi-technology/tree/main/_includes"
    click A_assets "https://github.com/bcdigschol/edi-technology/tree/main/assets"
    click A_sass "https://github.com/bcdigschol/edi-technology/tree/main/_sass"
    click A_tailwind "https://github.com/bcdigschol/edi-technology/blob/main/tailwind.config.js"
    click A_postcss "https://github.com/bcdigschol/edi-technology/blob/main/postcss.config.js"
    click CD_github "https://github.com/bcdigschol/edi-technology/blob/main/.github"
    click D_index "https://github.com/bcdigschol/edi-technology/blob/main/index.html"
    click D_404 "https://github.com/bcdigschol/edi-technology/blob/main/404.html"

    %% Styles
    classDef dev fill:#ffebcd,stroke:#333,stroke-width:2px;
    classDef jekyll fill:#cce5ff,stroke:#333,stroke-width:2px;
    classDef asset fill:#d4edda,stroke:#333,stroke-width:2px;
    classDef buildoutput fill:#e2eafc,stroke:#333,stroke-width:2px;
    classDef cicd fill:#ffeeba,stroke:#333,stroke-width:2px;
    classDef deploy fill:#f8d7da,stroke:#333,stroke-width:2px;
```
