docs: README 全篇精简 — 折叠分组 + 去重 + 英文降为次级 - #3
Merged
Conversation
功能表原本 35 行平铺无分组,并排双语让每行都撑成一堵墙(英文列 9703 字符, 是中文 4697 的两倍,占全表 67% 体量)。按主题归成 8 个 <details> 折叠组: 账号与登录 / 服务端与实例 / 控制台·运行·网络 / 可观测性 / 文件·插件·配置 / 备份 / 多租户与配额 / 面板自身。折叠标题带一行关键词概括,展开才看细节。 35 行内容逐字保留 —— 每条「它拒绝做什么」的说明是这份 README 最值钱的部分, 一句没删。唯一改写的是 🧮 内存配额那行(上个 PR 加的,1362 字符,全表最长): ARCHITECTURE.md 里已有完整的「内存配额的口径」一节,README 再铺一遍纯属冗余, 压成判断 + 指路。 组标题的 emoji 换成 Emoji 1.0 时代的通用码位 —— 原先行内用的 🗀 (U+1F5C0) 和 ⧉ (U+29C9) 字体覆盖很差,当小图标无所谓,提成标题就会明显露馅。 注意:源文件反而从 205 行涨到 270 行(<details> 标记的开销)。这次减的是首屏 阅读负担,不是内容体量。 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
功能表之外的几节同样处理: **快速开始** —— 原本 4 个并列 H3(一行安装 / Docker / deploy.sh / 手动),读者 要先读完四种方案才知道该用哪个。改成主推一行安装 + 默认账户 + Java 说明, 其余三种和自定义目录/端口折进「其他安装方式」,建实例与外置登录折进「接下来做什么」。 **架构** —— 删掉 README 里那份 `src/` 模块清单:ARCHITECTURE.md 的「总览」 有更详细的版本(每个模块一行说明 + 依赖方向),README 再抄一遍压缩版没有意义。 保留顶层数据流图和权限模型图,那两张是 ARCHITECTURE 没有的快速一览。 **仓库结构** —— 并入架构节的折叠块。原来它和架构节都在讲文件布局,是两处重复; `data/` 的逐文件说明 ARCHITECTURE 有表格,这里只留指路。同时保留 ARCHITECTURE 没有的部分:scripts/、Dockerfile、ecosystem.config.js、backups/ 的增量链内部结构。 **英文** —— 统一降为 <sub> 次级样式,中文主、英文辅,不再等重占版面。 顺带两处: - 去掉「115 项冒烟回归」这个数字。实跑只有 73 项(无实例时会跳过实例级用例), 我无法确认 115 是否准确,与其留一个验证不了的数字不如不写。 - 清掉 11 处行尾冗余 `<br>` —— GitHub 本就把换行渲染成 <br>,显式再写一个会 多出一个空行。(第 14 行标题区那处是 main 上原有的,未动。) 效果:全部折叠时首屏可见文字从 18845 字降到 3507 字(-81%),整份文档一屏可览。 源文件仍比 main 大(205 → 261 行)—— <details> 标记本身有开销,减的是阅读负担 不是字节数。 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
两个 commit,先功能表、后其余各节。
现状
src/模块清单,和 仓库结构 一节,都在讲文件布局 —— 两处重复,且ARCHITECTURE.md有更详细的版本改动
功能表 → 8 个
<details>折叠组,标题带关键词概括:🔐 账号与登录 · 📦 服务端与实例 · 💻 控制台·运行·网络 · 📊 可观测性 · 📁 文件·插件·配置 · 💾 备份 · 👥 多租户与配额 · ⚙ 面板自身
35 行内容逐字保留 —— 每条「它拒绝做什么」是这份 README 最值钱的部分,一句没删。用脚本按行号搬运而非手抄,集合比对验证 34/35 行 byte-identical。唯一改写的是 🧮 内存配额那行(ARCHITECTURE 已有完整的「内存配额的口径」一节,压成判断 + 指路)。
快速开始 → 主推一行安装 + 默认账户 + Java 说明,其余折进「其他安装方式」与「接下来做什么」。
架构 → 删掉 README 那份
src/清单(ARCHITECTURE「总览」每模块一行说明 + 依赖方向,更详细);保留顶层数据流图与权限模型图,那两张 ARCHITECTURE 没有。仓库结构并入折叠块,只留 ARCHITECTURE 没覆盖的(scripts/、Dockerfile、ecosystem.config.js、backups/ 增量链内部结构)。英文统一降为
<sub>次级样式,中文主、英文辅。效果
源文件反而变大了 ——
<details>标记本身有开销。减的是阅读负担,不是字节数。若你要的是真的砍内容,说一声,那需要另一种做法(把「为什么这么设计」抽成独立小节只留最精彩的 8-10 条,或中英拆两份文档)。顺带两处
<br>:GitHub 本就把换行渲染成<br>,显式再写会多出一个空行。第 14 行标题区那处是 main 上原有的,未动。验证
全程用 GitHub 自己的
POST /markdown(mode=gfm) 渲染核对,不是靠眼看:<details>/ 8 个<table>/ 功能表数据行 35 / 6 个代码块,全部正确渲染(
<details>里的表格依赖<summary>后的空行,漏了会退化成纯文本 —— 必须实测)bin/java/一项确实只此一份,已补回运行时目录块🗀(U+1F5C0)、⧉(U+29C9) 字体覆盖差,当行内小图标无所谓,提成组标题就露馅🤖 Generated with Claude Code