Skip to content

docs: fix README diagram links - #1210

Open
dajiaohuang wants to merge 1 commit into
cloudwego:mainfrom
dajiaohuang:docs/1208-fix-readme-diagrams
Open

docs: fix README diagram links#1210
dajiaohuang wants to merge 1 commit into
cloudwego:mainfrom
dajiaohuang:docs/1208-fix-readme-diagrams

Conversation

@dajiaohuang

Copy link
Copy Markdown

What type of PR is this?

docs

Check the PR title.

  • This PR title matches the format: <type>(optional scope): <description>.
  • The description of this PR title is user-oriented and clear enough for others to understand.
  • No user-documentation PR is required; this change repairs repository README assets only.

(Optional) Translate the PR title into Chinese.

docs: 修复 README 架构图链接

(Optional) More detailed description for this PR(en: English/zh: Chinese).

en:

Both README variants still reference two JPEGs that were deleted when the current PNG diagrams were added. This updates the four references to tracked replacement assets:

  • the project structure and modules diagram for the introductory concept section;
  • the architecture overview diagram for the framework structure section.

Validation:

  • verified every local Markdown image target in both README files exists;
  • verified both deleted JPEG references are absent;
  • git diff --check passes;
  • confirmed the old raw-content URLs return 404 and the replacement URLs return 200.

zh(optional): 两份 README 仍引用已删除的 JPEG。本 PR 将 4 处链接更新为仓库中现有的项目结构图和架构总览图。

(Optional) Which issue(s) this PR fixes:

Fixes #1208

(optional) The PR that updates user documentation:

Not required; this only fixes repository README image references.

@codecov

codecov Bot commented Aug 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.40%. Comparing base (ebd616c) to head (6b38d5b).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1210      +/-   ##
==========================================
- Coverage   83.46%   83.40%   -0.07%     
==========================================
  Files         162      162              
  Lines       23676    23676              
==========================================
- Hits        19762    19747      -15     
- Misses       2644     2654      +10     
- Partials     1270     1275       +5     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

docs: README diagrams reference deleted image files

1 participant