# stevezhengme/training-sagemaker-storytelling architecture

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

- Interactive diagram: https://gitdiagram.com/stevezhengme/training-sagemaker-storytelling
- Repository: https://github.com/stevezhengme/training-sagemaker-storytelling

## Overview

##### Project type and purpose
- This is a documentation‐focused repository (“A Story of Machine Learning in Big Companies”) containing a sequence of “story” Markdown files in English and Chinese.
- It uses Git branches and shell scripts to scaffold and manage per‐month story branches in two languages.

##### File structure
- Top‐level files:
- README.md / README.zh.md – project overview in two languages
- LICENSE, .gitignore
- Language directories:
- cn/growth/01_Jan.md … 12_Dec.md
- en/growth/01_Jan.md … 12_Dec.md
- en/change/01_Jan.md … 12_Dec.md
- tools/:
- init_branches.sh – script to create Git branches for each story
- init_files.sh – script to scaffold Markdown files

##### README for additional insights
- Purpose: provide 24 monthly “stories” (12-growth, 12-change), in English and Chinese.
- Workflow hint: each story exists on its own branch (“G_Jan”, etc.) plus a “story” branch for reading.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Authors' Workspace" 
        style Authors' Workspace stroke-dasharray: 5 5
        direction TB
        LR1["Local Repository"]:::repo
        ReadEN["README.md"]:::repo
        ReadCN["README.zh.md"]:::repo
        Gitignore[".gitignore"]:::repo
        License["LICENSE"]:::repo
        IB["tools/init_branches.sh"]:::script
        IF["tools/init_files.sh"]:::script
        subgraph "Content Directories"
            direction TB
            EGro["en/growth/"]:::folder
            ECha["en/change/"]:::folder
            CGro["cn/growth/"]:::folder
        end
        BR["Branches (G_Jan … C_Dec)"]:::branch
        SB["story branch"]:::branch
    end

    GH["GitHub Remote"]:::cloud

    LR1 -->|"run init_branches.sh"| IB
    IB -->|"creates branches"| BR
    LR1 -->|"run init_files.sh"| IF
    IF -->|"scaffold markdown"| EGro
    IF -->|"scaffold markdown"| ECha
    IF -->|"scaffold markdown"| CGro
    BR -->|"merged into"| SB
    SB -->|"push to origin"| GH
    LR1 -->|"push to origin"| GH

    click LR1 "https://github.com/stevezhengme/training-sagemaker-storytelling/tree/story//"
    click ReadEN "https://github.com/stevezhengme/training-sagemaker-storytelling/blob/story/README.md"
    click ReadCN "https://github.com/stevezhengme/training-sagemaker-storytelling/blob/story/README.zh.md"
    click Gitignore "https://github.com/stevezhengme/training-sagemaker-storytelling/blob/story/.gitignore"
    click License "https://github.com/stevezhengme/training-sagemaker-storytelling/tree/story/LICENSE"
    click IB "https://github.com/stevezhengme/training-sagemaker-storytelling/blob/story/tools/init_branches.sh"
    click IF "https://github.com/stevezhengme/training-sagemaker-storytelling/blob/story/tools/init_files.sh"
    click EGro "https://github.com/stevezhengme/training-sagemaker-storytelling/tree/story/en/growth/"
    click ECha "https://github.com/stevezhengme/training-sagemaker-storytelling/tree/story/en/change/"
    click CGro "https://github.com/stevezhengme/training-sagemaker-storytelling/tree/story/cn/growth/"

    classDef repo fill:#D6EAF8,stroke:#3498DB,color:#1B4F72;
    classDef folder fill:#D6EAF8,stroke:#2471A3,color:#1B2631;
    classDef script fill:#D5F5E3,stroke:#27AE60,color:#145A32;
    classDef branch fill:#FDEBD0,stroke:#E67E22,color:#6E2C00;
    classDef cloud fill:#EBDEF0,stroke:#8E44AD,color:#4A235A;
```
