Skip to content

docs(README): 双语 README 嵌入 archify 图——架构图替换 framework.png + Roadmap 里程碑表图化 - #125

Open
ThreeFish-AI wants to merge 1 commit into
feature/1.x.xfrom
ThreeFish-AI/readme-archify-diagrams
Open

docs(README): 双语 README 嵌入 archify 图——架构图替换 framework.png + Roadmap 里程碑表图化#125
ThreeFish-AI wants to merge 1 commit into
feature/1.x.xfrom
ThreeFish-AI/readme-archify-diagrams

Conversation

@ThreeFish-AI

Copy link
Copy Markdown
Owner

概述

c10ab3c 建立的 archify 图资产体系延伸到两份 README:架构图(engineering-plan-layers)替换旧的 media/framework.png(无主题适配的旧图),Roadmap 里程碑表格转换为 archify 生成图;同步完成中英双语与 GitHub 深浅色主题适配。

变更内容

1. 双语 README 嵌入替换(4 处)

位置 原内容 新内容
根 README(英)Architecture 节 media/framework.png 单图 <picture> 深浅自适应 · media/diagrams/EN 2x PNG(2640×1120)
根 README(英)Roadmap 节 M0-M5 Markdown 表格 <picture> · EN 2x PNG(2272×564)+ 台账链接
中文 README 架构节 media/framework.png <picture> · 复用现有中文 SVG 深浅对
中文 README 路线图节 中文 M0-M5 表格 <picture> · 新中文 SVG 深浅对 + 台账链接

每处嵌入均附仓库标准 blockquote 链接行(交互版 HTML · Mermaid 源图 · 图资产索引)。

2. 双语与主题适配策略

  • -en 后缀变体:根 README 需英文标注图——新增 engineering-plan-layers-enroadmap-milestones-en,镜像中文版拓扑/配色/节点 id,仅译标签(英文 title/aria/lang="en");
  • 根 README 用 PNG、docs 用 SVG:根 README 同时是扩展店面 README(Marketplace / Open VSX 不渲染 SVG,且 docs/** 不入 vsix)→ 嵌入打包范围内的 media/diagrams/*.pngdocs/ 下按惯例嵌入 SVG。

3. 新图资产(3 套四件套,遵守 .mmd → archify → 矩阵 变更顺序)

  • milestones/roadmap-milestones(中)/ roadmap-milestones-en(英):workflow 类型横向 M0→M5,阶段带「已交付(M0-M4 · 截至 v0.0.18)/ 规划中(M5)」,M5 虚线 + amber;与 implementation-status.md §1 台账核实;
  • architecture/engineering-plan-layers-en:英译变体;
  • 删除失去引用的 media/framework.png(原仅两 README 引用)。

4. 登记与规范

  • 溯源矩阵 +1 处既有行更新(中文架构图嵌入文档补 README(中))+3 新行;
  • 资产索引新增 milestones/ 分类节 + 2 行、architecture/ 表 +1 行;
  • 绘制规范新增 3 条:⑥ -en 双语变体规则(中文版拓扑变更时同步重绘)、⑦ 根 README PNG 导出(Marketplace 兼容)与 #gh-*-mode-only 片段兜底预案。

验证

  • ✅ 3 套新产物 archify showcase 9 项检查零错误零警告
  • visual-check 1440×900 / 1600×1000 / 1920×1080 / 2048×1320 双主题无溢出(含既有中文架构图基线对照);
  • ✅ PNG 尺寸恰为 2× viewBox(2640×1120 / 2272×564);
  • vsce package 解包实证:4 张 PNG 入包、<img src> 重写为绝对 GitHub raw URL(Marketplace 渲染保障;srcset 未重写属预期降级——Marketplace 回退显示浅色版);
  • ✅ GitHub 实机验证(分支 blob 页 + 深色模拟):4 个 <picture>currentSrc 均随 prefers-color-scheme 正确切换并加载;
  • git grep framework.png 无残留;全部相对路径逐一解析核验。

影响面

纯文档与图资产变更,不触及源码与功能;vsix 增量约 +0.7MB(4 张 PNG)。

🤖 Generated with Claude Code, CodeX, Gemini

…程碑表图化;

- 根 README(英):Architecture 节与 Roadmap 表替换为 <picture> 深浅自适应嵌入(media/diagrams/ 下 EN 2x PNG,Marketplace 兼容;vsce 打包实证 img src 重写为绝对 raw URL);
- 中文 README:同构替换为 docs/assets 深浅 SVG 对(该文件仅 GitHub 渲染);
- 新增 milestones/ 图分类:roadmap-milestones(中/英)四件套——M0-M4 已交付、M5 待启动(虚线),与 implementation-status.md §1 台账核实;
- 新增 engineering-plan-layers-en 英译变体(镜像中文版拓扑/配色,仅译标签,英文 title/aria/lang);
- 溯源矩阵 + 资产索引登记 3 张新图并更新既有嵌入行;绘制规范新增 -en 双语变体、根 README PNG 导出、Marketplace 片段兜底 3 条规则;
- 删除失去引用的 media/framework.png(原仅两份 README 引用);
- 3 套新产物均通过 archify showcase 9 项检查零错误零警告 + visual-check 1440×900 双主题无溢出。

🤖 Generated with [Claude Code](https://github.com/claude), [CodeX](https://openai.com), [Gemini](https://github.com/apps/gemini-code-assist)
Co-Authored-By: Aurelius Huang<threefish.ai@gmail.com>
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