# gemarodri/capstone499 architecture

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

- Interactive diagram: https://gitdiagram.com/gemarodri/capstone499
- Repository: https://github.com/gemarodri/capstone499

## Overview

##### Project Type and Purpose
- This repository is not a traditional full-stack application but a static course website/content management system for “COSC 499: Capstone Software Engineering Project.”
- Key artifacts: Markdown files (lectures, assignments, resources, schedule), a Jekyll configuration file (_config.yml), and supporting PDFs. These indicate a static-site generator (Jekyll) serving as the platform.

##### File Structure Analysis
- Top-level directories each represent a content category:
- Assigments/ – markdown templates & deliverable guidelines
- Resources/ – supplemental readings & how-to guides
- Slides/ – lecture slide decks (PDF)
- Suggestions/ – week-by-week recommended steps
- Supporting files: projects.md, tentativeschedule.md, EvaluationCriteria.md
- _config.yml implies Jekyll is used to transform markdown into HTML.
- README.md provides course overview and links to other md files.

##### README Insights
- No runtime components (no server-side code, no databases).
- Emphasis on static content, links, and schedule outline.
- No mention of dynamic interactions beyond standard GitHub Pages hosting.

a. Main Components
- Content Repository (Markdown + PDFs)
- Static Site Generator (Jekyll + plugins)
- Build Environment (local dev machine or CI pipeline)
- Hosting Service (GitHub Pages)
- End-user Client (web browser)

b. Relationships & Data Flow
1. Contributor commits markdown/PDF changes to GitHub repo.
2. CI or local Jekyll build reads _config.yml, applies templates, outputs HTML/CSS/JS assets.
3. Build artifacts are pushed to GitHub Pages (gh-pages branch).
4. End users access the live site via browser.

c. Architectural Patterns & Principles
- Static Site Generation: content-first, write once–publish everywhere.
- GitOps: all content and config in Git, version controlled.
- CI/CD pipeline (optional) automates build & deploy.

d. Key Technologies
- Jekyll (Ruby-based SSG)
- Git/GitHub for version control & hosting
- Markdown for content
- GitHub Actions or similar for automated builds (if present)

##### Detailed Yet Focused
- Plugin or configuration steps (e.g., “_config.yml sets baseurl, theme”).
- Don’t over-componentize: treat each content folder as one block unless a deeper breakdown is needed.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Developer initiates content updates
    Developer["Developer"]:::enduser

    %% Content Repository
    subgraph "Content Repository"
        AssigmentsDir["Assigments/"]:::source
        ResourcesDir["Resources/"]:::source
        SlidesDir["Slides/"]:::source
        SuggestionsDir["Suggestions/"]:::source
        README["README.md"]:::source
        ProjectsMD["projects.md"]:::source
        ScheduleMD["tentativeschedule.md"]:::source
        EvalCriteria["EvaluationCriteria.md"]:::source
        MoreInfoMD["MoreInformation.md"]:::source
        PeerPDF["PeerTestingSessions.pdf"]:::source
    end

    %% Static Site Generator Configuration
    Config["_config.yml"]:::source

    %% Build Engine
    Jekyll["Jekyll Engine"]:::processing

    %% Hosting Service
    GitHubPages["GitHub Pages"]:::hosting

    %% End User
    Browser["Web Browser"]:::enduser

    %% Connections
    Developer -->|git push| AssigmentsDir
    Developer -->|git push| ResourcesDir
    Developer -->|git push| SlidesDir
    Developer -->|git push| SuggestionsDir
    Developer -->|git push| README
    Developer -->|git push| ProjectsMD
    Developer -->|git push| ScheduleMD
    Developer -->|git push| EvalCriteria
    Developer -->|git push| MoreInfoMD
    Developer -->|git push| PeerPDF

    AssigmentsDir -->|included in build| Jekyll
    ResourcesDir -->|included in build| Jekyll
    SlidesDir -->|included in build| Jekyll
    SuggestionsDir -->|included in build| Jekyll
    README -->|included in build| Jekyll
    ProjectsMD -->|included in build| Jekyll
    ScheduleMD -->|included in build| Jekyll
    EvalCriteria -->|included in build| Jekyll
    MoreInfoMD -->|included in build| Jekyll
    PeerPDF -->|included in build| Jekyll
    Config -->|provides config| Jekyll

    Jekyll -->|jekyll build| GitHubPages
    GitHubPages -->|GET / 200 OK| Browser

    %% Click Events for Content Repository
    click AssigmentsDir "https://github.com/gemarodri/capstone499/tree/main/Assigments/"
    click ResourcesDir "https://github.com/gemarodri/capstone499/tree/main/Resources/"
    click SlidesDir "https://github.com/gemarodri/capstone499/tree/main/Slides/"
    click SuggestionsDir "https://github.com/gemarodri/capstone499/tree/main/Suggestions/"
    click README "https://github.com/gemarodri/capstone499/blob/main/README.md"
    click ProjectsMD "https://github.com/gemarodri/capstone499/blob/main/projects.md"
    click ScheduleMD "https://github.com/gemarodri/capstone499/blob/main/tentativeschedule.md"
    click EvalCriteria "https://github.com/gemarodri/capstone499/blob/main/EvaluationCriteria.md"
    click MoreInfoMD "https://github.com/gemarodri/capstone499/blob/main/MoreInformation.md"
    click PeerPDF "https://github.com/gemarodri/capstone499/blob/main/PeerTestingSessions.pdf"
    click Config "https://github.com/gemarodri/capstone499/blob/main/_config.yml"

    %% Styles
    classDef source fill:#ADD8E6,stroke:#000,stroke-width:1px
    classDef processing fill:#90EE90,stroke:#000,stroke-width:1px
    classDef hosting fill:#FFA500,stroke:#000,stroke-width:1px
    classDef enduser fill:#DDA0DD,stroke:#000,stroke-width:1px
```
