Skip to content

About

GitHub 新手全功能 DAG 教程:面向零基础读者的交互式功能关系图谱(35 节点/41 边/7 组/9 层,含历史维度与可溯源来源)

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

GitHub 新手全功能 DAG 教程

面向完全没用过 GitHub 的读者的交互式功能关系图谱教程。GitHub 的几十个功能不是孤立的——仓库、分支、提交、Release、Fork、PR、Issue、Actions……彼此依赖、互相承接。本教程用一张**功能关系图谱(DAG)**把它们的依赖关系讲清楚。

快速开始

想做什么 去哪
🎯 交互式功能关系图(推荐第一个打开) 04-interactive/index.html
🗂️ 功能组目录 03-groups/index.html
💡 从 GitHub 历史看到的 6 条普遍规律 08-patterns/index.html
📄 每个功能一页(介绍/双轨操作/关系/小结) 02-pages/(35 页)
🖼️ 关键流程图(静态) 05-drawio/(6 张 drawio+png)
🤖 AI 友好 MD 镜像 06-md/(索引/分组/分层/全节点)
📚 教程对比分析报告 09-tutorial-analysis/analysis.html(HTML 人类阅读版;同目录 analysis.md 为 AI 源文件)
📊 DAG 数据 01-dag-data/github-dag.json

全站 47 个页面(35 节点页 + 7 组页 + 组目录 + 交互总览 + 规律页 + 根入口 + 分析报告)。

目录结构

0817-github-dag/
├── 01-dag-data/          # DAG 数据: github-dag.json (35节点 + 41边 + 7组 + 9层)
├── 02-pages/             # 每功能一页 HTML(35 页)
├── 03-groups/            # 7 组索引页 + 组目录
├── 04-interactive/       # cytoscape 交互总览(组级视图+点击下钻)+ vendor
├── 05-drawio/            # 6 张关键流程图(全貌/Git vs GitHub/仓库生命周期/Fork→PR/Release/Actions)
├── 06-md/                # AI 友好 MD 镜像
├── 07-checkpoint/        # 中间产物与生成脚本(合并/生成/门控)
├── 08-patterns/          # 第 47 页:6 条历史规律(★ 由 build-html.py 产出,⛔ 不手写)
├── 09-tutorial-analysis/ # 教程对比分析报告(analysis.html 人类阅读版 + analysis.md AI 源文件)
└── semantic-layers.json  # ★ 语义层表:4 层 × 四项规格的**唯一真相源**(生成器只读它、门控只判它)

语义层(版式层次)

网页的语义层次不是靠「多加几个组件」表达的,而是靠每层各配一套版式记号。 semantic-layers.json 是这件事的唯一真相源,四个层在容器类型 / 尺寸档 / 强调记号 / 可交互记号四项上互不相同:

层 用在哪 容器 尺寸档 强调记号 可交互
action 入口动作 首页「从这里开始」(含规律页入口卡) grid lg 左侧色条 hover + focus
nav 导航 首页「按组浏览」/ 组页学习路径 / 规律页继续浏览 list md 序号 hover + focus
claim 论点 规律页 6 条规律 / 节点页心智模型与小结 list sm 顶部细线 ⛔ 无 hover
data 数据 节点关系表 / 组内功能表 / 组目录表 table xs 无 ⛔ 无 hover

尺寸档走「基准 + 层偏移」两值表(令牌见生成器 ROOT_TOKENS 的 --layer-*-base / --layer-*-off-*)。 ★ 6 条历史规律自批 H 起独立成页(08-patterns/index.html),首页只留一个 action 层入口卡 —— 原先三者共用同一个卡片栅格,层次分辨率为 0。

核心数据

  • 35 功能节点:G00 前置概念(2) / G01 账号与仓库(6) / G02 版本管理(7) / G03 协作(5) / G04 项目管理(5) / G05 自动化部署(4) / G06 工具生态(6)
  • 41 关系边,四种语义:
    • 🔶 前置依赖(PREREQ):先学会它才能做这件事
    • 🟢 包含从属(CONTAINS):它建立在另一个功能之上
    • 🟣 概念升级(UPGRADE):理解后帮助你进阶到更高层次
    • 🔵 流程承接(FLOW):前一步的产出被后一步消费
  • 9 拓扑层:层序 = 学习顺序(Layer 0 版本控制基础 → Layer 8 包管理)
  • 边方向 = 学习顺序:A→B 表示先学 A 再学 B

内容来源与交叉验证

  • 官方:docs.github.com 全流程文档(Get started / Repositories / Pull requests / Actions / Issues / Pages / Packages / Code security / CLI / Desktop / API / Codespaces / Gists)
  • 英文权威教程:GitHub Hello World、freeCodeCamp、Atlassian Git Tutorials、Pro Git 书、GeeksforGeeks、GitHub Skills
  • 中文高赞教程:菜鸟教程、廖雪峰 Git 教程、阮一峰博客、CSDN 新手文
  • 4 路联网调研(代理 127.0.0.1:7890 + Google)→ 交叉验证 → 教程分析报告驱动编写
  • 历史维度(二次迭代):3 路调研(git-scm 书 / github.blog 官方公告 / 维基百科)为每功能页补充"历史背景"区块(诞生时间/当时痛点/需求变迁/历史教训,全可溯源)。年份以官方一手来源为准(如 Issues=2009、正式 Reviews=2016、Fork 2008 已可用)

拓扑分层速览

  • Layer 0(1):版本控制基础
  • Layer 1(3):Git vs GitHub / Git 命令行基础 / Gist
  • Layer 2(3):账号与Profile / Commit / GitHub CLI
  • Layer 3(3):创建仓库 / Branch / Tag
  • Layer 4(13):仓库骨架 / 远程仓库 / Star Watch / 协作者权限 / Issue / 讨论区 / 维基 / Dependabot / API / Codespaces / Merge / Pages / Release
  • Layer 5(6):克隆仓库 / Push Pull / Fork / Notifications / Team / Milestone
  • Layer 6(2):Desktop / Pull Request
  • Layer 7(3):Code Review / Projects看板 / Actions
  • Layer 8(1):Packages

质量门控

本站无 CI,门控在生成器收尾处内联执行(fail-closed:门控非 0 ⇒ 生成视为失败):

门控 判什么 怎么跑
07-checkpoint/quality-gate.py 内容面 9 组:JSON 合法 / DAG 无环 / 孤立节点 / 字段完整 / HTML 断链 / 无 .md 链接 / drawio-png 配套 / 8 区块模板 / 历史区块 / UTF-8 python3 07-checkpoint/quality-gate.py
07-checkpoint/gate_layers.py 设计面 9 条:G1 空集守卫 · L1 层表完整性 · L2 CSS 实现(含 claim/data 无 hover)· L3 同页层集合 · L4 令牌单源 + --border 对比度(对 --bg 3.90 / 对 --panel 3.60,阈值 3.0)· L5 零引用令牌登记双向(--ext / --ok 已登记为已确认未修)· L6 页数守恒 + 规律迁移 · L7 无恒假分支 · L8 门控清单双向 python3 07-checkpoint/gate_layers.py(负向夹具:--selftest,35 项 0 FAIL)

门控清单:07-checkpoint/gate-manifest.json(登记 + reads + selftest,⛔ 无豁免字段); 每次运行的门控报告:07-checkpoint/gate-report.json。

重新生成

cd 07-checkpoint
python3 merge-dag.py && python3 merge-history.py && python3 build-html.py \
  && python3 build-md.py && python3 md2html.py && python3 quality-gate.py && python3 verify-json.py

★ build-html.py 会读仓根的 semantic-layers.json 并重生成全部 47 个页面(含 08-patterns/index.html), 收尾自动跑 gate_layers.py;⛔ 页面与报告都是产物,不要手改。

About

GitHub 新手全功能 DAG 教程:面向零基础读者的交互式功能关系图谱(35 节点/41 边/7 组/9 层,含历史维度与可溯源来源)

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages