Skip to content

Commit d3844a4

Browse files
Merge pull request #1 from anneheartrecord/chore/maintenance-2026-08
Repository maintenance: fix cross-link 404s, add LICENSE, CI checks, and contribution governance
2 parents a27555b + ab45027 commit d3844a4

49 files changed

Lines changed: 1046 additions & 227 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: Chapter correction / 章节纠错
2+
description: A passage contradicts the actual source behavior, a number is wrong, or a module's responsibility is misdescribed
3+
title: "[correction] "
4+
labels: ["correction", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Factual corrections are the highest-priority issue type here. A teardown that states something wrong gets quoted downstream as a conclusion, so thank you for catching it.
10+
11+
修正事实性错误是本仓库优先级最高的 issue。源码解读一旦写错,会被读者当结论引用。
12+
13+
- type: dropdown
14+
id: chapter
15+
attributes:
16+
label: Chapter / 章节
17+
options:
18+
- "01 — Architecture Overview / 架构总览"
19+
- "02 — Value Debate / 源码泄露的价值之争"
20+
- "03 — Agent Loop / Agent 循环"
21+
- "04 — Context Engineering / 上下文工程"
22+
- "05 — Compaction System / 消息压缩系统"
23+
- "06 — Permission System / 权限系统"
24+
- "07 — Memory System / 记忆管理"
25+
- "08 — Tools and Skills / 工具与 Skill 系统"
26+
- "09 — MCP Integration / MCP 集成"
27+
- "10 — Future Features / 未来功能蓝图"
28+
- "11 — AI Code Review / AI Coding 时代的 Code Review"
29+
- "12 — Agent Security Design / 从权限系统学 Agent 安全设计"
30+
- "13 — Source Code Findings / 啃完源码之后的一些发现"
31+
validations:
32+
required: true
33+
34+
- type: input
35+
id: language
36+
attributes:
37+
label: Which language version / 哪个语言版本
38+
description: Chinese, English, or both
39+
placeholder: both
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: quote
45+
attributes:
46+
label: Quote the passage / 引用原文
47+
description: Copy the sentence or table row as it currently reads, and say which section it is in.
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: correction
53+
attributes:
54+
label: What it should say / 正确的描述是什么
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
id: evidence
60+
attributes:
61+
label: Evidence / 证据
62+
description: |
63+
Required. Any one of: a source file path plus symbol name, reproducible steps that demonstrate the behavior, or a link to official documentation. An issue without evidence will be sent back before it can be acted on.
64+
65+
必填。三者任一即可:源码文件路径 + 符号名 / 可复现的操作步骤 / 官方文档链接。没有证据的 issue 会被要求补充后才处理。
66+
validations:
67+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Read the docs online / 在线阅读
4+
url: https://anneheartrecord.github.io/claude-code-docs/
5+
about: The published site, with search across all 13 chapters.
6+
- name: Contributing guide / 贡献指南
7+
url: https://github.com/anneheartrecord/claude-code-docs/blob/main/CONTRIBUTING.md
8+
about: What corrections are wanted, and the evidence bar for a factual correction.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: New chapter proposal / 新章节提议
2+
description: Propose a module or theme that deserves its own teardown
3+
title: "[chapter] "
4+
labels: ["new-chapter", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Proposals are welcome; whole AI-generated chapters submitted as pull requests are not. Open this first so the scope and the angle can be agreed on.
10+
11+
欢迎提议新章节;但不接受直接提交 AI 生成的整章 PR。先开这个 issue,把范围和切入角度谈好。
12+
13+
- type: input
14+
id: topic
15+
attributes:
16+
label: Topic / 主题
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: why
22+
attributes:
23+
label: Why it deserves a chapter / 为什么值得单开一章
24+
description: What would a reader building an agent product be able to do afterward that they cannot do now?
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: scope
30+
attributes:
31+
label: What the chapter would cover / 章节大致覆盖什么
32+
description: Rough section list is enough.
33+
validations:
34+
required: true
35+
36+
- type: checkboxes
37+
id: overlap
38+
attributes:
39+
label: Overlap check / 重叠检查
40+
options:
41+
- label: I have read the existing 13 chapters and this is not already covered
42+
required: true
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Version drift / 版本漂移
2+
description: Upstream changed, and a chapter now describes a mechanism that no longer exists
3+
title: "[drift] "
4+
labels: ["version-drift", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
The analysis was performed against a specific source snapshot — see the version coverage table in the README. Upstream moves; chapters go stale. Reporting drift is how this stays honest.
10+
11+
本仓库的分析基于某个特定的源码快照(见 README 的版本覆盖表)。上游会变,章节会过时。报告漂移是这份文档保持诚实的方式。
12+
13+
- type: input
14+
id: chapter
15+
attributes:
16+
label: Chapter / 章节
17+
placeholder: "06 — Permission System"
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: described
23+
attributes:
24+
label: What the chapter describes / 章节里怎么写的
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: actual
30+
attributes:
31+
label: What upstream does now / 上游现在的行为
32+
validations:
33+
required: true
34+
35+
- type: input
36+
id: version
37+
attributes:
38+
label: Version you observed this in / 你观察到的版本
39+
description: Output of `claude --version`, or the npm version.
40+
placeholder: "2.1.227"
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: evidence
46+
attributes:
47+
label: Evidence / 证据
48+
description: Source path plus symbol, reproducible steps, changelog entry, or official documentation.
49+
validations:
50+
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!--
2+
中文贡献者可以用中文填写。
3+
Contributors may fill this in in Chinese or English.
4+
-->
5+
6+
## What this changes / 改了什么
7+
8+
<!-- One or two sentences. If it fixes an issue, write "Fixes #123". -->
9+
10+
## Type / 类型
11+
12+
- [ ] Factual correction / 事实纠错
13+
- [ ] Version drift update / 版本漂移更新
14+
- [ ] Translation or wording / 翻译与表述
15+
- [ ] Links, formatting, tooling / 链接、排版、工具链
16+
- [ ] New content / 新增内容 (discussed in an issue first / 已在 issue 中讨论过)
17+
18+
## Evidence / 证据
19+
20+
<!--
21+
Required for factual corrections and drift updates.
22+
Source path plus symbol, reproducible steps, or official documentation.
23+
事实纠错与版本漂移必填:源码路径 + 符号名 / 可复现步骤 / 官方文档。
24+
-->
25+
26+
## Checklist / 自检
27+
28+
- [ ] `python3 scripts/check_links.py` passes / 通过
29+
- [ ] `python3 scripts/check_bilingual.py` passes / 通过
30+
- [ ] Chinese and English sides both updated, if the change is factual / 事实性改动已中英双语同步
31+
- [ ] Commit messages follow Conventional Commits / commit message 符合 Conventional Commit
32+
- [ ] This PR does one thing / 这个 PR 只解决一件事

.github/workflows/docs-check.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: docs-check
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
# Catch rot that arrives without anyone touching the repo.
8+
schedule:
9+
- cron: "0 2 * * 1"
10+
workflow_dispatch:
11+
12+
jobs:
13+
check:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
18+
- uses: actions/setup-python@v5
19+
with:
20+
python-version: "3.12"
21+
22+
- name: Validate links and link conventions
23+
run: python3 scripts/check_links.py
24+
25+
- name: Validate bilingual chapter parity
26+
run: python3 scripts/check_bilingual.py

.gitignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# IDE
2+
.idea/
3+
.vscode/
4+
*.iml
5+
6+
# OS
7+
.DS_Store
8+
Thumbs.db
9+
10+
# Editor scratch
11+
*.swp
12+
*~

.idea/.gitignore

Lines changed: 0 additions & 8 deletions
This file was deleted.

.idea/claude-code-anatomy.iml

Lines changed: 0 additions & 9 deletions
This file was deleted.

.idea/modules.xml

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)