# michiganadc/dmsc-madc architecture

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

- Interactive diagram: https://gitdiagram.com/michiganadc/dmsc-madc
- Repository: https://github.com/michiganadc/dmsc-madc

## Overview

##### Main Components
- Quarto Rendering Engine: This is the core processor that converts .qmd files into a static website. It’s configured via the _quarto.yml file.
- Content Files: These include all the .qmd files (e.g., index.qmd, about.qmd, publications.qmd, etc.) as well as other documents (data_dictionary.qmd, label_libraries.qmd, etc.), which serve as the website’s pages.
- Assets and Resources: The assets directory (with subdirectories for CSS, images, label libraries, and team bios) holds all design, branding, and media resources.
- Deployment Pipeline: This includes GitHub Actions workflows from the .github/workflows directory and the .nojekyll file ensuring proper GitHub Pages deployment.
- Supporting Files/Configuration: Files like README.md and setup notes offer contributor documentation, while the file tree indicates a clean separation of content, configuration, and resources.

##### Detail the Relationships and Interactions
- The Quarto engine (as configured in _quarto.yml) processes the .qmd files using styles from assets/css and supporting scripts/styles from README_files/libs.
- Rendered content is output into a designated folder (docs as per instructions), which is then served by GitHub Pages.
- The development environment (i.e., VS Code with the Quarto extension) is used to modify the content and preview changes locally before committing.
- The GitHub Actions workflow (found under .github/workflows) automates any tasks related to publishing or continuous deployment when changes are pushed to the main branch.

##### Architectural Patterns and Design Principles
- Static Site Architecture: The overall design is that of a static website built from source content (Markdown) and rendered by a build tool (Quarto).
- Separation of Concerns: Content is maintained separately in .qmd files, styling and scripts in the assets/ and README_files directories, and the build configuration in _quarto.yml.
- Declarative Configuration: The project uses a declarative configuration (Quarto’s YAML files) to determine the output and deployment directories, ensuring consistency across development and deployment.
- Continuous Deployment: The integration with GitHub Pages (via changes to docs, .nojekyll, and automated workflows) ensures that every change can be deployed directly from the repository.

##### Relevant Technologies, Frameworks, and Tools
- Quarto: The static site generator and publishing engine as the core technology.
- Git and GitHub: Version control and hosting that enable collaborative development and deployment through GitHub Pages.
- Visual Studio Code: The recommended IDE for development with the Quarto extension for live preview and document rendering.
- CSS and Bootstrap (as seen in the README_files/libs): Indicating the styling framework in use.

##### Additional Details
- Provide annotations to denote that updates in the .qmd files or assets are processed via Quarto, which applies the site configuration provided by _quarto.yml.
- Notes on how GitHub Actions automates the rendering process and deployment to GitHub Pages, emphasizing the end-to-end workflow from commit to live site.

## Diagram (Mermaid)

```mermaid
graph TD
    subgraph "Source Repository"
        subgraph "Content Files (.qmd)"
            IDX["index.qmd"]:::content
            ABT["about.qmd"]:::content
            PUB["publications.qmd"]:::content
            DD["data_dictionary.qmd"]:::content
            DI["data_insights.qmd"]:::content
            LL["label_libraries.qmd"]:::content
            RMD["request_madrc_data.qmd"]:::content
            RES["resources.qmd"]:::content
        end
        subgraph "Assets and Resources"
            AST["assets/"]:::asset
            CSS["assets/css/styles.css"]:::asset
            IMG["assets/images"]:::asset
            AL["assets/label_libraries"]:::asset
            TB["assets/team_bios"]:::asset
            LIB["README_files/libs"]:::asset
        end
        subgraph "Supporting Files"
            RD["README.md"]:::support
            SN["setup_notes.txt"]:::support
        end
        subgraph "Quarto Configuration"
            QRC["_quarto.yml"]:::config
        end
        subgraph "Deployment Pipeline"
            WP[".github/workflows/publish.yml"]:::deploy
            NJ[".nojekyll"]:::deploy
        end
    end

    LD["Local Development (VS Code)"]:::dev

    QRE["Quarto Rendering Engine"]:::processing

    DOCS["Docs Folder (Rendered Website)"]:::deploy
    GP["GitHub Pages (Hosted Site)"]:::deploy

    %% Flow: Content and Assets processed by Quarto Rendering Engine
    IDX --> QRE
    ABT --> QRE
    PUB --> QRE
    DD --> QRE
    DI --> QRE
    LL --> QRE
    RMD --> QRE
    RES --> QRE
    AST --> QRE
    CSS --> QRE
    IMG --> QRE
    AL --> QRE
    TB --> QRE
    LIB --> QRE
    RD --> QRE
    SN --> QRE
    QRC --> QRE

    %% Local development
    LD --> QRE

    %% Build output and deployment flow
    QRE --> DOCS
    DOCS --> GP
    QRE -->|"trigger_build"| WP
    WP --> GP
    NJ --> GP

    %% Style Definitions
    classDef content fill:#daf7a6,stroke:#333,stroke-width:2px;
    classDef asset fill:#a6e7da,stroke:#333,stroke-width:2px;
    classDef support fill:#f7d6a6,stroke:#333,stroke-width:2px;
    classDef config fill:#d6a6f7,stroke:#333,stroke-width:2px;
    classDef processing fill:#a6d8f7,stroke:#333,stroke-width:2px;
    classDef deploy fill:#f7a6a6,stroke:#333,stroke-width:2px;
    classDef dev fill:#fff5ba,stroke:#333,stroke-width:2px;

    %% Click Events
    click QRC "https://github.com/michiganadc/dmsc-madc/blob/main/_quarto.yml"
    click IDX "https://github.com/michiganadc/dmsc-madc/blob/main/index.qmd"
    click ABT "https://github.com/michiganadc/dmsc-madc/blob/main/about.qmd"
    click PUB "https://github.com/michiganadc/dmsc-madc/blob/main/publications.qmd"
    click DD "https://github.com/michiganadc/dmsc-madc/blob/main/data_dictionary.qmd"
    click DI "https://github.com/michiganadc/dmsc-madc/blob/main/data_insights.qmd"
    click LL "https://github.com/michiganadc/dmsc-madc/blob/main/label_libraries.qmd"
    click RMD "https://github.com/michiganadc/dmsc-madc/blob/main/request_madrc_data.qmd"
    click RES "https://github.com/michiganadc/dmsc-madc/blob/main/resources.qmd"
    click AST "https://github.com/michiganadc/dmsc-madc/tree/main/assets/"
    click CSS "https://github.com/michiganadc/dmsc-madc/blob/main/assets/css/styles.css"
    click IMG "https://github.com/michiganadc/dmsc-madc/tree/main/assets/images"
    click AL "https://github.com/michiganadc/dmsc-madc/tree/main/assets/label_libraries"
    click TB "https://github.com/michiganadc/dmsc-madc/tree/main/assets/team_bios"
    click LIB "https://github.com/michiganadc/dmsc-madc/tree/main/README_files/libs"
    click WP "https://github.com/michiganadc/dmsc-madc/blob/main/.github/workflows/publish.yml"
    click NJ "https://github.com/michiganadc/dmsc-madc/blob/main/.nojekyll"
    click RD "https://github.com/michiganadc/dmsc-madc/blob/main/README.md"
    click SN "https://github.com/michiganadc/dmsc-madc/blob/main/setup_notes.txt"
```
