Skip to content

feat: 19-chapter docs quality overhaul — CC source-verified, beginner-friendly#265

Open
Bill-Billion wants to merge 6 commits intoshareAI-lab:mainfrom
Bill-Billion:feat/docs-quality-overhaul
Open

feat: 19-chapter docs quality overhaul — CC source-verified, beginner-friendly#265
Bill-Billion wants to merge 6 commits intoshareAI-lab:mainfrom
Bill-Billion:feat/docs-quality-overhaul

Conversation

@Bill-Billion
Copy link
Copy Markdown

@Bill-Billion Bill-Billion commented May 1, 2026

Summary

全面重写 19 章教学文档,基于 CC 源码逐项验证,统一叙事骨架:

  • 19 章完整覆盖:s01 Agent Loop → s19 MCP Plugin,5 阶段递进
  • CC 源码深度验证:30 个 Explore Agent 调用,覆盖 80+ CC 源码文件,每章 <details> 折叠中有精确函数名、行号和常量值
  • 统一叙事骨架:痛点 → 鸟瞰/核心思路 → 机制展开 → 速查 → 试一下 → 接下来
  • 复杂章用 h3 问题→解法→然后呢 节奏:s03(三道闸门)、s08(四层压缩)、s09(三个子系统)、s11(三条恢复路径)
  • 10 张 SVG 流程图
  • 17 岁友好:痛点驱动叙事,术语就地定义,主线 100-280 行,细节折叠,零内部工程术语
  • 三语平级:README.md / README.en.md / README.ja.md 同目录

Key design decisions

  • s03/s08/s09/s11 每层机制用 h3 问题→解法→然后呢 节奏串联,s08 还额外有合起来跑
  • CC 源码分析全部折叠进 <details>,不污染教学主线
  • s17 开篇诚实标注为教学虚构
  • 每章结尾统一格式:上章遗留问题 → 下章预告

Test plan

  • 19 章 README 完整性
  • 导航链连贯性 (s01→s02→...→s19)
  • SVG 文字溢出检查
  • 残留旧术语清零
  • 叙事链通顺性

🤖 Generated with Claude Code

…-friendly

全面重写 19 章教学文档,基于 CC 源码逐项验证,统一叙事骨架。

核心变更:
- 19 章从 s01 Agent Loop 到 s19 MCP Plugin,5 阶段递进
- 每章统一骨架:痛点 → 核心思路 → 机制展开 → 速查 → 试一下 → 接下来
- 30 个 Explore Agent 调用,覆盖 80+ CC 源码文件,行号精确定位
- 10 张 SVG 流程图(s01/s02/s03/s08×4/s09/s15/s19)
- 复杂章用 <details> 折叠 CC 源码对照,主线保持 100-280 行
- 17 岁友好:术语就地定义,无内部工程术语,叙事驱动
- README 总入口含 19 章地图和 5 阶段划分

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 1, 2026

@Bill-Billion is attempting to deploy a commit to the crazyboym's projects Team on Vercel.

A member of the Team first needs to authorize it.

Bill-Billion and others added 5 commits May 1, 2026 10:26
Rename h3 headings from 痛→修法→还剩什么 to 问题→解法→然后呢
for more natural, conversational flow matching s01's narrative voice.
Apply the layered h3 structure to s03 (3 gates), s09 (3 subsystems),
and s11 (3 recovery paths) — previously only s08 used this pattern.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Previously only s01 and s08 had links; now all s01-s19 are clickable.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Update chapter count (12→19), motto list, stage table, chapter links,
project structure, and quick start paths in both README-zh.md and
README-ja.md to match the new 19-chapter format.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
…vious

Rewrite all 19 code.py files to show explicit "在 sXX 基础上新增" lineage:
- Docstring states which chapter this builds on and what was added
- Visual markers (═══ FROM sXX / NEW in sYY ═══) separate inherited
  from new code
- agent_loop comments show exact line changes from previous chapter
- Print message at startup tells reader which chapter they're extending

This restores the "incremental optimization" soul that made the original
agents/s01-s12 version feel like a coherent step-by-step build, rather
than 19 disconnected standalone chapters.

s01-s04: Full cumulative code with markers
s05-s08: Cumulative code with markers (compact for later chapters)
s09-s19: Incremental docstrings + agent_loop with change annotations

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Each chapter (s02-s19) now has a "相对 sXX 的变更" table showing
exactly what was added compared to the previous chapter — new tools,
new functions, new data structures, and agent_loop changes.

This restores the incremental "diff" feel from the original docs/
version, where readers could see at a glance "what did this chapter
add?" without comparing code files.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant