Skip to content

docs(readme): slim README down to overview + quick start, point at docs site (#167)#193

Open
g1331 wants to merge 1 commit into
masterfrom
docs/readme-slim-167
Open

docs(readme): slim README down to overview + quick start, point at docs site (#167)#193
g1331 wants to merge 1 commit into
masterfrom
docs/readme-slim-167

Conversation

@g1331
Copy link
Copy Markdown
Owner

@g1331 g1331 commented May 27, 2026

Summary

Issue #167 收尾 P1 第 1 项:README 双语减负。

文档站 34/34 已合入 master、docs/index.mddocs/en/index.md 在 PR #192 中也已修订过对外文案,本 PR 把两份 README 中与文档站重复的部署 / 环境变量 / 项目结构 / 开发指南段落删除,仅保留 GitHub 仓库首页真正需要的内容。

改动范围

段落 原行数 新行数 处理
Hero / badges / 语言切换 1-34 保留
目录 38-46 缩减 同步章节
功能特性 2×2 表 50-96 保留(仓库首屏卖点)
界面预览(桌面 + 移动端) 100-138 保留
Docker compose 启动 152-168 极简 保留最小可用
Release / 个人部署 4 步 170-224 0 删,跳链 guide/deployment/github-actions
本地开发 PG / SQLite 两种方案 219-281 0 删,跳链 guide/deployment/overview
环境变量表 19 行 285-309 0 删,跳链 guide/deployment/env-reference
项目结构 9 行 312-324 0 删,跳链 guide/architecture/overview
开发指南(lint/test/db)三块 328-365 0 删,跳链 guide/architecture/testing + contributing
「文档与延伸阅读」表 新增 6 条跳链汇总
License 369-379 保留

总行数:README.md 380 → 184,README_EN.md 373 → 188。删除/新增统计:2 files changed, 34 insertions(+), 415 deletions(-)

README_EN.md 额外增加一段顶部 blockquote,说明文档站当前仅维护简体中文以及推荐的阅读工作流(与 PR #192docs/en/index.md 文案口径一致)。

Test plan

  • CI Quality 通过(prettier / eslint / tsc)
  • 在 GitHub PR 页面预览 README.mdREADME_EN.md 渲染,确认 hero banner、badges、<details> 折叠截图、移动端 2x2 截图表、跳链表均无样式漂移
  • 文档站链接逐个 404 自查(部署 / 使用 / 架构三栏入口 + env-reference + github-actions + testing + contributing)
  • 在仓库首页点击「English」/「简体中文」切换两份 README,确认相互跳转无误

Related

…ink to docs site (#167)

文档站 34/34 已上线后,README 中的部署细节、环境变量表、项目结构、开发指南
在文档站均已有更完整版本。本提交移除 README 内重复段落,仅保留:
- Hero / badges / 语言切换
- 功能特性 2x2 表(GitHub 仓库首屏卖点)
- 界面预览(桌面 + 移动端截图)
- 极简 Docker compose 快速开始
- 「文档与延伸阅读」表(指向文档站各章节)
- License

zh / en 两份 README 同步缩减,总行数从 ~380 降到 ~185。
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