Skip to content

fix(docs): correct duplicated text in the Chinese book structure overview image#17

Open
shaun0927 wants to merge 13 commits into
lintsinghua:mainfrom
shaun0927:fix/chinese-book-structure-overview-asset
Open

fix(docs): correct duplicated text in the Chinese book structure overview image#17
shaun0927 wants to merge 13 commits into
lintsinghua:mainfrom
shaun0927:fix/chinese-book-structure-overview-asset

Conversation

@shaun0927

Copy link
Copy Markdown

Background

Issue #15 reports that the second image in the foreword has duplicated/malformed text.

I reproduced that problem on current main in a local clone:

  • OCR on assets/book_structure_overview.png detected 第3章 工具系统 智能体操作 twice at different vertical positions.
  • OCR also detected malformed title text in the Chinese asset.
  • The English counterpart (en/assets/book_structure_overview.png) did not show the same duplication.

What changed

  • replaced/regenerated assets/book_structure_overview.png
  • removed the duplicated Chapter 3 label in the Chinese asset
  • corrected the malformed top title text in the Chinese asset
  • left the English asset unchanged because local validation did not show a corresponding defect there

Scope

This PR intentionally stays narrow to match the repository's recent merge pattern for documentation fixes:

  • one validated problem
  • one asset changed
  • no unrelated documentation edits

Validation

  • local OCR before: duplicated 第3章 工具系统 智能体操作 appeared twice
  • local OCR after: only one 第3章 工具系统 智能体操作 remains
  • local OCR after: title reads 智能体系统课程路线图:从基础到生产(2021年-至今)
  • PNG format remains valid after the update

Closes #15

lanshi17 and others added 12 commits April 3, 2026 16:12
docs(foreword): 替换Mermaid图表为静态图片以优化渲染性能

- 将AI编程范式演进的Mermaid流程图替换为静态PNG图片
- 将书籍结构概述的Mermaid图表替换为静态PNG图片
- 移除复杂的Mermaid语法,提高文档加载速度
- 同时更新中英文版本的前言文档
```
feature:将前言部分的图片进行优化
fix: 修复第06章链接边界与第10章Mermaid渲染问题
去掉不通用的 leftPadding 配置,用短横线代替冒号和括号避免语法冲突,
修正时间线重叠。中英文同步更新。

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
docs(assets): 修复图片路径并替换Mermaid图表为静态图片

- 修复了中文和英文版本中图片路径从"asserts"到"assets"的拼写错误
- 将第1章中的4个Mermaid图表替换为对应的静态图片,包括:
  - LLM人机交互流程图
  - 六大工程挑战图
  - AI编程工具演进时间线
  - Claude Code架构全景图
- 更新了前言中的相关图片引用
- 添加了新的基础篇图片资源文件
```
Fix image paths and replace Mermaid charts with static images
将 JPEG 数据错误保存为 .png 的图片重新编码为正确的 PNG 格式,
并将分辨率从 5504x3040 缩小至 1400px 宽,解决 GitHub 渲染 404 问题。

Fixes lintsinghua#10

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The current Chinese `book_structure_overview` asset duplicates the
Chapter 3 label and contains malformed title text. This keeps the
fix narrowly scoped to the one image that issue lintsinghua#15 identifies,
matching the repository's documentation-first contribution pattern.

Constraint: Keep the PR limited to the validated Chinese asset defect
Rejected: Open a new issue in English | duplicate of upstream issue lintsinghua#15
Rejected: Modify the English asset too | local validation showed no corresponding defect
Confidence: medium
Scope-risk: narrow
Reversibility: clean
Directive: If a source design file is introduced later, prefer regenerating this asset from source rather than layering manual edits on top
Tested: Local OCR shows one Chapter 3 label and corrected title text; PNG MIME preserved
Not-tested: Human visual review in GitHub's final renderer
Related: lintsinghua#15
The first fix removed the duplicated Chapter 3 label and corrected
the title text, but the cleared text band could still read as an
editing artifact. This follow-up redraws the left panel so the asset
remains visually consistent while preserving the validated content fix.

Constraint: Stay within the existing one-asset PR scope
Rejected: Leave the OCR-correct but visually patched version as-is | visible cleanup band weakened the polish of the diagram
Rejected: Rebuild additional assets for consistency | no corresponding defect was validated elsewhere
Confidence: medium
Scope-risk: narrow
Reversibility: clean
Directive: If the original design source becomes available, prefer regenerating the asset from source rather than iterating on raster edits
Tested: Local OCR still finds one Chapter 3 label, one Chapter 4 label, and the corrected title text; PNG MIME preserved
Not-tested: Maintainer preference for the redrawn panel styling versus the prior asset styling
Related: lintsinghua#15
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.

前言的第二张配图有点问题

4 participants