# turntabl/git-training architecture

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

- Interactive diagram: https://gitdiagram.com/turntabl/git-training
- Repository: https://github.com/turntabl/git-training

## Overview

##### Project type and purpose
- Project type: Open-source training/documentation repository.
- Purpose: Provide a set of discrete, hands-on Git exercises (each in its own folder) plus a central README and cheatsheet.

##### Top-level structure analysis
- Root directory: contains the master README.md (project overview & cheatsheet).
- Subdirectories: one per exercise (e.g., basic-commits, basic-staging, basic-branching, etc.), each with its own README.md.
- No code, no build scripts, no runtime components—pure content.

a. Repository container (“git-training” on GitHub)
b. Central README + Cheatsheet
d. External Actors / Services:
- Learner (clones the repo, works locally)
- Tutor/Reviewer (clones or browses remotely)
- Git CLI & Local Git Engine
- GitHub (remote host)

##### Relationships & data flows
- Tutor → GitHub (reviews pushed branches or PRs)

##### Design principles
- Modular content: each exercise is self-contained in its own directory.
- Single source of truth: all instructions and reference commands live in Markdown files under version control.
- Extensibility: new exercises can be added as new folders without altering existing structure.

##### Technologies & frameworks
- Markdown (documentation format)
- Git (version control)
- GitHub (hosting & collaboration)
- Local file system (as the “runtime environment” for exercises)

- Optional notes on the side: “Add more exercises by creating new folders under /basic-commits, etc.”

- The modular folder structure of git-training
- How users interact with it via Git and GitHub

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph git-training["git-training Repository"]
        entry["README.md & Cheatsheet"]:::doc
        subgraph Exercises
            bc["basic-commits"]:::doc
            bs["basic-staging"]:::doc
            bb["basic-branching"]:::doc
            bcl["basic-cleaning"]:::doc
            bsh["basic-stashing"]:::doc
            br["basic-revert"]:::doc
            am["amend"]:::doc
            re["reset"]:::doc
            sq["squashing"]:::doc
            tm["3-way-merge"]:::doc
            ff["ff-merge"]:::doc
            rb["rebase-branch"]:::doc
            ria["rebase-interactive-autosquash"]:::doc
            ari["advanced-rebase-interactive"]:::doc
            rh["reorder-the-history"]:::doc
        end
    end

    learner["Learner"]:::actor
    tutor["Tutor/Reviewer"]:::actor
    gitcli["Git CLI & Local Git Engine"]:::service
    github["GitHub"]:::service

    learner -->|"git clone"| entry
    learner -->|"runs commands"| gitcli
    gitcli -->|"mutates content"| entry
    learner -->|"git push / PR"| github
    tutor -->|"review PRs"| github

    classDef doc fill:#cce5ff,stroke:#004085,color:#004085;
    classDef actor fill:#d4edda,stroke:#155724,color:#155724;
    classDef service fill:#fff3cd,stroke:#856404,color:#856404;

    click entry "https://github.com/turntabl/git-training/blob/main//README.md"
    click bc "https://github.com/turntabl/git-training/blob/main//basic-commits/README.md"
    click bs "https://github.com/turntabl/git-training/blob/main//basic-staging/README.md"
    click bb "https://github.com/turntabl/git-training/blob/main//basic-branching/README.md"
    click bcl "https://github.com/turntabl/git-training/blob/main//basic-cleaning/README.md"
    click bsh "https://github.com/turntabl/git-training/blob/main//basic-stashing/README.md"
    click br "https://github.com/turntabl/git-training/blob/main//basic-revert/README.md"
    click am "https://github.com/turntabl/git-training/blob/main//amend/README.md"
    click re "https://github.com/turntabl/git-training/blob/main//reset/README.md"
    click sq "https://github.com/turntabl/git-training/blob/main//squashing/README.md"
    click tm "https://github.com/turntabl/git-training/blob/main//3-way-merge/README.md"
    click ff "https://github.com/turntabl/git-training/blob/main//ff-merge/README.md"
    click rb "https://github.com/turntabl/git-training/blob/main//rebase-branch/README.md"
    click ria "https://github.com/turntabl/git-training/blob/main//rebase-interactive-autosquash/README.md"
    click ari "https://github.com/turntabl/git-training/blob/main//advanced-rebase-interactive/README.md"
    click rh "https://github.com/turntabl/git-training/blob/main//reorder-the-history/README.md"
```
