Skip to content

docs: 修复 README 图片链接并迁移至 R2 - #1108

Merged
xerrors merged 1 commit into
mainfrom
docs/readme-r2-images
Oct 15, 2026
Merged

xerrors merged 1 commit into
mainfrom
docs/readme-r2-images

Conversation

@xerrors

@xerrors xerrors commented Oct 15, 2026

Copy link
Copy Markdown
Owner

变更说明

README 中的 OSS 默认域名图片无法经 GitHub Camo 正常展示。将 README.md 的 33 处和 README.en.md 的 32 处图片链接改用已配置的 R2 自定义域名,保留文件路径和其他内容。

- https://xerrors.oss-cn-shanghai.aliyuncs.com/<原文件路径>
+ https://oss-img.xerrors.cn/<原文件路径>
  • 任务类型:bug-fix(文档链接)
  • 目标与非目标:恢复中英文 README 图片展示;不修改应用代码、文案或其他资源链接。
  • substantial / trivial 判断:trivial,仅替换两份 README 中的图片域名。

工程主张与 Owner

  • 受影响的工程主张:README 的 33 张不同图片可以由 GitHub Camo 抓取,且与原图内容一致。
  • Owner / commit point / 观察边界:图片内容由 R2 yuxi-images Bucket 拥有,oss-img.xerrors.cn 提供 HTTPS 访问;README 拥有图片引用,合并后生效。通过真实下载与 SHA-256 比较验证。
  • 决策记录:trivial 域名替换,不新增架构或代码行为,免除决策记录。

验证情况

图片可由 GitHub Camo 展示且内容不变

  • 失败面:源图下载策略、DNS/TLS、对象缺失或迁移内容变化。
  • 语义 Owner:两份 README 图片引用、R2 对象和自定义域名。
  • 直接证据 / 命令:GitHub Markdown render API 为新域名生成 Camo URL;curl 下载全部 33 张图片,并与原 OSS 图片 SHA-256 比较,33/33 一致。浏览器实际预览封面为 1280×640;正式域名响应 Content-Type 为 image/png,且无强制下载头。
  • 负向案例:旧 OSS 示例响应含 Content-Disposition: attachment 与 x-oss-force-download: true;原 GitHub 裂图现象见 Docs: GitHub 页面上的 README 截图无法正常显示 (Camo 代理 404) #1107。不新增复述域名替换的测试。
  • 结果:Passed。

修改范围与仓库检查

  • 失败面:误改正文、路径、其他链接或文档构建回归。
  • 语义 Owner:README.md、README.en.md 与仓库文档构建流程。
  • 直接证据 / 命令:将新域名反向替换后,逐文件与 HEAD 内容完全一致;git diff --check 通过;python3 scripts/verify_engineering_contracts.py 通过;python3 -m unittest scripts.test_verify_engineering_contracts 通过(63 tests);pnpm --dir docs run build 通过。
  • 负向案例:不适用,本次未引入代码 guard。
  • 结果:Passed。

简化 / 删除验收

不涉及。

独立语义 Review

Not run:仅为 README 图片域名替换,无应用代码变更;已核对完整 diff、替换可逆一致性以及全部 33 张图片的真实代理抓取结果。

未验证范围与风险

  • docker compose exec api uv run --group test pytest test/unit -m "not slow":Not run,本机未安装 Docker(command not found);本次不涉及后端代码。
  • GitHub main 分支实际 README 渲染:Not run,需合并后确认;新域名的全部图片已通过同一 GitHub Camo 代理实际抓取验证。
  • 域名与图片托管依赖 Cloudflare/R2 可用性。回滚只需还原两份 README,未删除原 OSS 对象。

事故反馈

未达到高影响逃逸缺陷门槛:仅影响项目说明页截图展示。

界面变更

不涉及应用界面或交互修改。

关联事项

Closes #1107

补充说明

R2 Bucket 与自定义域名已配置并验证;原文件路径保持一致,临时 r2.dev 测试入口已关闭。

@xerrors
xerrors marked this pull request as ready for review October 15, 2026 10:39
Copilot AI balanced review requested due to automatic review settings October 15, 2026 10:39

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@xerrors
xerrors merged commit ed70a2a into main Oct 15, 2026
1 check passed
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-15T10:41:15.243861Z c771fdb Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

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.

Docs: GitHub 页面上的 README 截图无法正常显示 (Camo 代理 404)

2 participants