Skip to content

docs: 在双语 README 中添加 GitHub 托管的 Demo 截图 - #25

Merged
z2z23n0 merged 2 commits into
mainfrom
feature/readme-github-images
Jul 23, 2026
Merged

docs: 在双语 README 中添加 GitHub 托管的 Demo 截图#25
z2z23n0 merged 2 commits into
mainfrom
feature/readme-github-images

Conversation

@z2z23n0

@z2z23n0 z2z23n0 commented Jul 23, 2026

Copy link
Copy Markdown
Owner

Mainline Intent

Intent: int_396b49d0
Status: proposed
Title: README 使用 GitHub 托管的双语 Demo 截图

What changed

在英文和中文 README 的简介后新增 Demo 区域。英文版展示导出、浏览器预览、导入、继续原生任务四张截图;中文版展示 V2EX 帖子中的浏览器预览和原生 Codex 继续两张截图。所有图片通过 GitHub README 编辑器上传并引用 user-attachments 地址,仓库不保存图片文件。

Why

用户希望 README 直接展示真实产品流程,同时避免为演示图片单独维护 docs 或 assets 目录,并要求使用 GitHub 编辑器提供的图片托管。

Decisions

  • Demo 图片的存储方式: 使用 GitHub user-attachments 托管,只在 README 中保存图片链接。 (符合用户明确要求,也避免仓库增加约 3.8 MB 的二进制图片。)
    • Rejected: 把图片保存到 docs/images/demo
    • Rejected: 继续使用旧提案中的仓库内生成素材
  • 中英文素材安排: 英文 README 使用四张英文流程图,中文 README 使用 V2EX 帖子的两张中文图。 (两种语言的读者分别看到对应界面与文案,且保持用户指定的素材来源。)
  • README 展示方式: 在语言切换链接之后使用可点击的双列表格展示图片。 (首屏能够快速看到完整流程,同时点击后可以查看原图细节。)

Subsystems: README.md, README.zh-CN.md

z2z23n0 added 2 commits July 24, 2026 00:26
Added a demo section to illustrate the full flow of exporting, previewing, and importing tasks.
Added a demonstration section with images for local decryption preview and task import in Codex.
@z2z23n0
z2z23n0 marked this pull request as ready for review July 23, 2026 16:34
@z2z23n0
z2z23n0 merged commit 654ce7c into main Jul 23, 2026
3 checks passed
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