Skip to content

Commit 9f6728f

Browse files
author
DevGraph
committed
docs: add localized graph documentation
1 parent a5a25c2 commit 9f6728f

37 files changed

Lines changed: 2695 additions & 1110 deletions

‎CONTRIBUTING.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Contributing
22

3+
[English](CONTRIBUTING.md) · [简体中文](CONTRIBUTING.zh-CN.md)
4+
35
Thanks for helping improve the DevGraph open skill graphs.
46

57
## What To Edit
@@ -21,8 +23,10 @@ Generated files:
2123

2224
- `graphs/{graphSlug}/index.json`
2325
- `graphs/{graphSlug}/README.md`
26+
- `graphs/{graphSlug}/index.en-US.md`
27+
- `graphs/{graphSlug}/index.zh-CN.md`
2428

25-
Do not hand-edit generated files to fix the table of contents. Change node hierarchy or ordering in `payload.json` instead.
29+
Do not hand-edit generated files to fix the table of contents or localized docs. Change bilingual content, node hierarchy, or ordering in `payload.json` instead.
2630

2731
## Node Guidelines
2832

‎CONTRIBUTING.zh-CN.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributing
2+
3+
[English](CONTRIBUTING.md) · [简体中文](CONTRIBUTING.zh-CN.md)
4+
5+
感谢你帮助改进 DevGraph 开放技能图谱。
6+
7+
## 修改哪里
8+
9+
大多数贡献只需要修改：
10+
11+
```text
12+
graphs/{graphSlug}/payload.json
13+
```
14+
15+
然后运行：
16+
17+
```bash
18+
npm run generate
19+
npm run validate
20+
```
21+
22+
生成文件包括：
23+
24+
- `graphs/{graphSlug}/index.json`
25+
- `graphs/{graphSlug}/README.md`
26+
- `graphs/{graphSlug}/index.en-US.md`
27+
- `graphs/{graphSlug}/index.zh-CN.md`
28+
29+
不要手工修改生成文件来调整目录、排序或语言文档。请在 `payload.json` 中修改双语内容、节点层级或 `sortOrder`，然后重新生成。
30+
31+
## 节点规范
32+
33+
每个节点应包含：
34+
35+
- 稳定的 `slug`
36+
- 合法的 `parentSlug`
37+
- 分类：`core`、`common` 或 `rare`
38+
- 数字类型的 `sortOrder`
39+
- 英文和中文内容
40+
- 简洁摘要，解释概念本身，而不只是重复标题
41+
42+
`rare` 用于较低频或更进阶的主题，官方只读预览中默认会隐藏这类节点。
43+
44+
## 变更理由
45+
46+
PR 应说明为什么新增、修改或删除节点。这个理由属于 review 上下文，不应写进 `payload.json`。
47+
48+
PR body 可使用这个结构：
49+
50+
```text
51+
Added nodes:
52+
- node-slug: Why this concept belongs in the graph.
53+
54+
Changed nodes:
55+
- node-slug: What changed and why it improves the graph.
56+
57+
Removed nodes:
58+
- node-slug: Why the graph is clearer without this node.
59+
```
60+
61+
## 官方预览
62+
63+
图谱同步后，官方只读预览地址是：
64+
65+
```text
66+
https://devgraph.dev/open/graphs/{graphSlug}
67+
```
68+
69+
完整学习工作区地址仍然是：
70+
71+
```text
72+
https://devgraph.dev/graphs/{graphSlug}
73+
```

‎README.md‎

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,39 @@
11
# Developer Skill Graphs
22

3+
[English](README.md) · [简体中文](README.zh-CN.md)
4+
35
Open skill graph data for [DevGraph](https://devgraph.dev).
46

57
This repository contains the public content source for selected DevGraph skill graphs: graph metadata, nodes, links, generated indexes, schemas, and validation scripts. DevGraph's app code, D3 implementation, learning workspace, practice questions, analysis reports, user data, and membership features are not part of this repository.
68

9+
The canonical source stays bilingual in each `payload.json`. Human-readable docs are generated beside each graph, following the same pattern used by projects such as Ant Design:
10+
11+
- `graphs/{graphSlug}/index.en-US.md`
12+
- `graphs/{graphSlug}/index.zh-CN.md`
13+
714
## Graphs
815

9-
| Skill | Source | Official preview | Learning workspace |
10-
| --- | --- | --- | --- |
11-
| React | [payload](graphs/react/payload.json) | [Preview](https://devgraph.dev/open/graphs/react) | [Workspace](https://devgraph.dev/graphs/react) |
12-
| Next.js | [payload](graphs/nextjs/payload.json) | [Preview](https://devgraph.dev/open/graphs/nextjs) | [Workspace](https://devgraph.dev/graphs/nextjs) |
13-
| TypeScript | [payload](graphs/typescript/payload.json) | [Preview](https://devgraph.dev/open/graphs/typescript) | [Workspace](https://devgraph.dev/graphs/typescript) |
14-
| JavaScript | [payload](graphs/javascript/payload.json) | [Preview](https://devgraph.dev/open/graphs/javascript) | [Workspace](https://devgraph.dev/graphs/javascript) |
15-
| Node.js | [payload](graphs/nodejs/payload.json) | [Preview](https://devgraph.dev/open/graphs/nodejs) | [Workspace](https://devgraph.dev/graphs/nodejs) |
16-
| Git & GitHub | [payload](graphs/git-github/payload.json) | [Preview](https://devgraph.dev/open/graphs/git-github) | [Workspace](https://devgraph.dev/graphs/git-github) |
17-
| Docker | [payload](graphs/docker/payload.json) | [Preview](https://devgraph.dev/open/graphs/docker) | [Workspace](https://devgraph.dev/graphs/docker) |
18-
| Redis | [payload](graphs/redis/payload.json) | [Preview](https://devgraph.dev/open/graphs/redis) | [Workspace](https://devgraph.dev/graphs/redis) |
19-
| PostgreSQL | [payload](graphs/postgresql/payload.json) | [Preview](https://devgraph.dev/open/graphs/postgresql) | [Workspace](https://devgraph.dev/graphs/postgresql) |
20-
| Linux | [payload](graphs/linux/payload.json) | [Preview](https://devgraph.dev/open/graphs/linux) | [Workspace](https://devgraph.dev/graphs/linux) |
16+
| Skill | Source | English | 中文 | Official preview | Learning workspace |
17+
| --- | --- | --- | --- | --- | --- |
18+
| React | [payload](graphs/react/payload.json) | [Doc](graphs/react/index.en-US.md) | [文档](graphs/react/index.zh-CN.md) | [Preview](https://devgraph.dev/open/graphs/react) | [Workspace](https://devgraph.dev/graphs/react) |
19+
| Next.js | [payload](graphs/nextjs/payload.json) | [Doc](graphs/nextjs/index.en-US.md) | [文档](graphs/nextjs/index.zh-CN.md) | [Preview](https://devgraph.dev/open/graphs/nextjs) | [Workspace](https://devgraph.dev/graphs/nextjs) |
20+
| TypeScript | [payload](graphs/typescript/payload.json) | [Doc](graphs/typescript/index.en-US.md) | [文档](graphs/typescript/index.zh-CN.md) | [Preview](https://devgraph.dev/open/graphs/typescript) | [Workspace](https://devgraph.dev/graphs/typescript) |
21+
| JavaScript | [payload](graphs/javascript/payload.json) | [Doc](graphs/javascript/index.en-US.md) | [文档](graphs/javascript/index.zh-CN.md) | [Preview](https://devgraph.dev/open/graphs/javascript) | [Workspace](https://devgraph.dev/graphs/javascript) |
22+
| Node.js | [payload](graphs/nodejs/payload.json) | [Doc](graphs/nodejs/index.en-US.md) | [文档](graphs/nodejs/index.zh-CN.md) | [Preview](https://devgraph.dev/open/graphs/nodejs) | [Workspace](https://devgraph.dev/graphs/nodejs) |
23+
| Git & GitHub | [payload](graphs/git-github/payload.json) | [Doc](graphs/git-github/index.en-US.md) | [文档](graphs/git-github/index.zh-CN.md) | [Preview](https://devgraph.dev/open/graphs/git-github) | [Workspace](https://devgraph.dev/graphs/git-github) |
24+
| Docker | [payload](graphs/docker/payload.json) | [Doc](graphs/docker/index.en-US.md) | [文档](graphs/docker/index.zh-CN.md) | [Preview](https://devgraph.dev/open/graphs/docker) | [Workspace](https://devgraph.dev/graphs/docker) |
25+
| Redis | [payload](graphs/redis/payload.json) | [Doc](graphs/redis/index.en-US.md) | [文档](graphs/redis/index.zh-CN.md) | [Preview](https://devgraph.dev/open/graphs/redis) | [Workspace](https://devgraph.dev/graphs/redis) |
26+
| PostgreSQL | [payload](graphs/postgresql/payload.json) | [Doc](graphs/postgresql/index.en-US.md) | [文档](graphs/postgresql/index.zh-CN.md) | [Preview](https://devgraph.dev/open/graphs/postgresql) | [Workspace](https://devgraph.dev/graphs/postgresql) |
27+
| Linux | [payload](graphs/linux/payload.json) | [Doc](graphs/linux/index.en-US.md) | [文档](graphs/linux/index.zh-CN.md) | [Preview](https://devgraph.dev/open/graphs/linux) | [Workspace](https://devgraph.dev/graphs/linux) |
2128

2229
## Repository Shape
2330

2431
```text
2532
graphs/{graphSlug}/payload.json # hand-edited source of truth
2633
graphs/{graphSlug}/index.json # generated reading order
27-
graphs/{graphSlug}/README.md # generated human-readable index
34+
graphs/{graphSlug}/README.md # generated directory entry
35+
graphs/{graphSlug}/index.en-US.md # generated English reading doc
36+
graphs/{graphSlug}/index.zh-CN.md # generated Chinese reading doc
2837
schema/*.schema.json # documented JSON shapes
2938
scripts/*.mjs # generation and validation tools
3039
```
@@ -38,7 +47,7 @@ npm run generate
3847
npm run validate
3948
```
4049

41-
`index.json` and graph `README.md` files are committed so GitHub can show a readable index, but they are derived from `payload.json`. Do not hand-edit them to fix ordering; change `parentSlug` or `sortOrder` in `payload.json`, then regenerate.
50+
`index.json`, graph `README.md`, and `index.*.md` files are committed so GitHub can show readable docs, but they are derived from `payload.json`. Do not hand-edit them to fix ordering; change bilingual content, `parentSlug`, or `sortOrder` in `payload.json`, then regenerate.
4251

4352
For contribution rules and the PR rationale template, see [CONTRIBUTING.md](CONTRIBUTING.md).
4453

‎README.zh-CN.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Developer Skill Graphs
2+
3+
[English](README.md) · [简体中文](README.zh-CN.md)
4+
5+
[DevGraph](https://devgraph.dev) 的开放技能图谱数据仓库。
6+
7+
本仓库包含部分 DevGraph 技能图谱的公开内容源：图谱元信息、节点、链接、生成索引、schema 和校验脚本。DevGraph 官网/产品源码、D3 实现、完整学习工作区、练习题、分析报告、用户数据和会员能力不在本仓库中。
8+
9+
每个 `payload.json` 都是双语内容源。面向人类阅读的文档会生成在对应图谱目录内，借鉴 Ant Design 这类项目的文件命名方式：
10+
11+
- `graphs/{graphSlug}/index.en-US.md`
12+
- `graphs/{graphSlug}/index.zh-CN.md`
13+
14+
## 图谱
15+
16+
| 技能 | 源数据 | English | 中文 | 官方只读预览 | 完整学习工作区 |
17+
| --- | --- | --- | --- | --- | --- |
18+
| React | [payload](graphs/react/payload.json) | [Doc](graphs/react/index.en-US.md) | [文档](graphs/react/index.zh-CN.md) | [预览](https://devgraph.dev/open/graphs/react) | [工作区](https://devgraph.dev/graphs/react) |
19+
| Next.js | [payload](graphs/nextjs/payload.json) | [Doc](graphs/nextjs/index.en-US.md) | [文档](graphs/nextjs/index.zh-CN.md) | [预览](https://devgraph.dev/open/graphs/nextjs) | [工作区](https://devgraph.dev/graphs/nextjs) |
20+
| TypeScript | [payload](graphs/typescript/payload.json) | [Doc](graphs/typescript/index.en-US.md) | [文档](graphs/typescript/index.zh-CN.md) | [预览](https://devgraph.dev/open/graphs/typescript) | [工作区](https://devgraph.dev/graphs/typescript) |
21+
| JavaScript | [payload](graphs/javascript/payload.json) | [Doc](graphs/javascript/index.en-US.md) | [文档](graphs/javascript/index.zh-CN.md) | [预览](https://devgraph.dev/open/graphs/javascript) | [工作区](https://devgraph.dev/graphs/javascript) |
22+
| Node.js | [payload](graphs/nodejs/payload.json) | [Doc](graphs/nodejs/index.en-US.md) | [文档](graphs/nodejs/index.zh-CN.md) | [预览](https://devgraph.dev/open/graphs/nodejs) | [工作区](https://devgraph.dev/graphs/nodejs) |
23+
| Git & GitHub | [payload](graphs/git-github/payload.json) | [Doc](graphs/git-github/index.en-US.md) | [文档](graphs/git-github/index.zh-CN.md) | [预览](https://devgraph.dev/open/graphs/git-github) | [工作区](https://devgraph.dev/graphs/git-github) |
24+
| Docker | [payload](graphs/docker/payload.json) | [Doc](graphs/docker/index.en-US.md) | [文档](graphs/docker/index.zh-CN.md) | [预览](https://devgraph.dev/open/graphs/docker) | [工作区](https://devgraph.dev/graphs/docker) |
25+
| Redis | [payload](graphs/redis/payload.json) | [Doc](graphs/redis/index.en-US.md) | [文档](graphs/redis/index.zh-CN.md) | [预览](https://devgraph.dev/open/graphs/redis) | [工作区](https://devgraph.dev/graphs/redis) |
26+
| PostgreSQL | [payload](graphs/postgresql/payload.json) | [Doc](graphs/postgresql/index.en-US.md) | [文档](graphs/postgresql/index.zh-CN.md) | [预览](https://devgraph.dev/open/graphs/postgresql) | [工作区](https://devgraph.dev/graphs/postgresql) |
27+
| Linux | [payload](graphs/linux/payload.json) | [Doc](graphs/linux/index.en-US.md) | [文档](graphs/linux/index.zh-CN.md) | [预览](https://devgraph.dev/open/graphs/linux) | [工作区](https://devgraph.dev/graphs/linux) |
28+
29+
## 仓库结构
30+
31+
```text
32+
graphs/{graphSlug}/payload.json # 手工编辑的内容源
33+
graphs/{graphSlug}/index.json # 生成的阅读顺序
34+
graphs/{graphSlug}/README.md # 生成的目录入口
35+
graphs/{graphSlug}/index.en-US.md # 生成的英文阅读文档
36+
graphs/{graphSlug}/index.zh-CN.md # 生成的中文阅读文档
37+
schema/*.schema.json # JSON 结构说明
38+
scripts/*.mjs # 生成和校验工具
39+
```
40+
41+
## 贡献方式
42+
43+
修改 `graphs/{graphSlug}/payload.json`，然后重新生成派生产物：
44+
45+
```bash
46+
npm run generate
47+
npm run validate
48+
```
49+
50+
`index.json`、单图谱 `README.md` 和 `index.*.md` 都会提交到仓库，方便 GitHub 直接展示；但它们都是从 `payload.json` 派生的。不要手工修改这些文件来调整顺序；应修改 `payload.json` 中的双语内容、`parentSlug` 或 `sortOrder`，然后重新生成。
51+
52+
贡献规则和 PR 变更理由模板见 [CONTRIBUTING.zh-CN.md](CONTRIBUTING.zh-CN.md)。
53+
54+
## 版本
55+
56+
每个 `payload.json` 都有顶层 `version` 字段。DevGraph 会把该值同步到官方应用中，作为公开图谱内容版本。
57+
58+
## License
59+
60+
MIT.

‎graphs/docker/README.md‎

Lines changed: 12 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -1,109 +1,17 @@
11
# Docker
22

3-
Docker is the leading containerization platform that packages applications and their dependencies into portable images, delivering environment consistency and rapid deployment—a core skill for backend, DevOps, and cloud-native engineering.
3+
[English](index.en-US.md) · [简体中文](index.zh-CN.md)
44

5-
- Version: 1.0.0
6-
- Nodes: 76
7-
- Source: [payload.json](payload.json)
8-
- Index: [index.json](index.json)
9-
- Official preview: https://devgraph.dev/open/graphs/docker
10-
- Learning workspace: https://devgraph.dev/graphs/docker
5+
- Version / 版本: 1.0.0
6+
- Nodes / 节点数: 76
7+
- Source / 源数据: [payload.json](payload.json)
8+
- Index / 生成索引: [index.json](index.json)
9+
- Official preview / 官方只读预览: https://devgraph.dev/open/graphs/docker
10+
- Learning workspace / 完整学习工作区: https://devgraph.dev/graphs/docker
1111

12-
## Knowledge Index
12+
## Files
1313

14-
### 1. Core Concepts
15-
16-
- 1.1 What is a Container
17-
- 1.2 Container vs VM
18-
- 1.3 Image vs Container
19-
- 1.4 Docker Architecture
20-
21-
### 2. Underlying Technologies
22-
23-
- 2.1 Linux Namespaces
24-
- 2.2 Linux cgroups
25-
- 2.3 Union Filesystem
26-
27-
### 3. Dockerfile & Image Building
28-
29-
- 3.1 Build Context
30-
- 3.2 Build Secrets
31-
- 3.3 Dockerfile
32-
- 3.4 FROM Instruction
33-
- 3.5 RUN Instruction
34-
- 3.6 CMD and ENTRYPOINT
35-
- 3.7 COPY and ADD
36-
- 3.8 WORKDIR / ENV / EXPOSE
37-
- 3.9 ARG Instruction
38-
- 3.10 .dockerignore
39-
- 3.11 Image Layer Caching
40-
- 3.12 Multi-Stage Build
41-
- 3.13 Image Size Optimization
42-
- 3.14 Base Image Selection
43-
- 3.15 BuildKit / buildx
44-
- 3.16 USER / HEALTHCHECK / LABEL
45-
46-
### 4. Image Management
47-
48-
- 4.1 docker build
49-
- 4.2 docker pull / push
50-
- 4.3 docker tag
51-
- 4.4 docker rmi / image prune
52-
53-
### 5. Container Management
54-
55-
- 5.1 Container Healthcheck
56-
- 5.2 docker run
57-
- 5.3 docker ps
58-
- 5.4 docker exec
59-
- 5.5 docker logs
60-
- 5.6 docker stop / rm
61-
- 5.7 docker inspect
62-
- 5.8 Container Resource Limits
63-
- 5.9 Interactive Mode
64-
65-
### 6. Data Persistence
66-
67-
- 6.1 Ephemeral Filesystem
68-
- 6.2 Volumes
69-
- 6.3 Bind Mounts
70-
- 6.4 Volume Management Commands
71-
- 6.5 tmpfs Mount
72-
73-
### 7. Networking
74-
75-
- 7.1 Docker Network Model
76-
- 7.2 Bridge Network
77-
- 7.3 Host Network
78-
- 7.4 Custom Network
79-
- 7.5 Port Mapping
80-
- 7.6 Docker DNS
81-
- 7.7 Overlay Network
82-
83-
### 8. Docker Compose
84-
85-
- 8.1 compose.yml Structure
86-
- 8.2 Services Configuration
87-
- 8.3 volumes & networks
88-
- 8.4 Environment Variables
89-
- 8.5 depends_on
90-
- 8.6 Compose CLI Commands
91-
- 8.7 Profiles
92-
- 8.8 healthcheck
93-
94-
### 9. Registries
95-
96-
- 9.1 Image Tagging Strategy
97-
98-
### 10. Container Security
99-
100-
- 10.1 Non-Root User
101-
- 10.2 Read-Only Filesystem
102-
- 10.3 Image Vulnerability Scanning
103-
- 10.4 Secrets Management
104-
- 10.5 Minimal Image Principle
105-
106-
### 11. Developer Workflow
107-
108-
- 11.1 Debugging Containers
109-
- 11.2 Docker Context
14+
- `payload.json`: bilingual source of truth
15+
- `index.json`: generated reading order
16+
- `index.en-US.md`: generated English reading doc
17+
- `index.zh-CN.md`: generated Simplified Chinese reading doc

0 commit comments

Comments
 (0)