Skip to content

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

Open
Bill-Billion wants to merge 2 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 2 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

@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 added a commit to Bill-Billion/learn-claude-code that referenced this pull request May 4, 2026
Q1: Remove stale sessions/zh/ directory (三套结构清理)
Q3: Fix s01 code.py path (sessions/zh → s01_agent_loop)
Q4: Extend SVG dangling lines to touch containers
Q5: Remove orphan fence lines breaking s02 README rendering
Q7: Fix s03 wording ("返回错误" → "返回一条阻止信息")

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Bill-Billion added a commit to Bill-Billion/learn-claude-code that referenced this pull request May 4, 2026
Q2: Replace stage labels ("阶段一:工具管线 | 第 1/4 章")
    with simple chapter numbering ("第 1/19 章")
    — beginner-friendly, no unexplained jargon

Q6: Add inline footnotes to s02 CC deep dive for forward references
    - TaskCreate → "(TaskCreate 在 s12 介绍)"
    - PreToolUse hooks → "(s04 详细介绍)"
    - Zod schema → "(教学版用 JSON Schema 替代)"
    - FileRead Infinity → expanded circular loop explanation

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

Rewrite code.py and README (zh/en/ja) for s01-s14, each chapter building
incrementally on the previous. Key fixes across chapters:

- s01-s04: agent loop, tool dispatch, permission pipeline, hooks
- s05-s08: todo write, subagent, skill loading, context compact
- s09-s11: memory system, system prompt assembly, error recovery
- s12-s14: task graph, background tasks, cron scheduler

All chapters CC source-verified. Code inherits fixes forward (PROMPT_SECTIONS,
json.dumps cache, real-state context, can_start dep protection, etc.).
…otocols, autonomy, worktree, MCP tools

Rewrite code.py and README (zh/en/ja) for s15-s19, the multi-agent platform
chapters. Each chapter inherits all previous fixes and adds one mechanism:

- s15: agent teams (TeamCreate, teammate threads, shared task list)
- s16: team protocols (plan approval, shutdown handshake, consume_inbox)
- s17: autonomous agents (idle polling, auto-claim, consume_lead_inbox)
- s18: worktree isolation (git worktree, bind_task, cwd switching, safety)
- s19: MCP tools (MCPClient, normalize_mcp_name, assemble_tool_pool, no cache)

All appendix source code references verified against CC source. Config priority
corrected: claude.ai < plugin < user < project < local.
@Bill-Billion Bill-Billion force-pushed the feat/docs-quality-overhaul branch from 9bedf7f to 7f4464b Compare May 9, 2026 07:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant