docs(readme): slim README down to overview + quick start, point at docs site (#167)#193
Open
g1331 wants to merge 1 commit into
Open
docs(readme): slim README down to overview + quick start, point at docs site (#167)#193g1331 wants to merge 1 commit into
g1331 wants to merge 1 commit into
Conversation
…ink to docs site (#167) 文档站 34/34 已上线后,README 中的部署细节、环境变量表、项目结构、开发指南 在文档站均已有更完整版本。本提交移除 README 内重复段落,仅保留: - Hero / badges / 语言切换 - 功能特性 2x2 表(GitHub 仓库首屏卖点) - 界面预览(桌面 + 移动端截图) - 极简 Docker compose 快速开始 - 「文档与延伸阅读」表(指向文档站各章节) - License zh / en 两份 README 同步缩减,总行数从 ~380 降到 ~185。
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.
Summary
Issue #167 收尾 P1 第 1 项:README 双语减负。
文档站 34/34 已合入 master、
docs/index.md与docs/en/index.md在 PR #192 中也已修订过对外文案,本 PR 把两份 README 中与文档站重复的部署 / 环境变量 / 项目结构 / 开发指南段落删除,仅保留 GitHub 仓库首页真正需要的内容。改动范围
guide/deployment/github-actionsguide/deployment/overviewguide/deployment/env-referenceguide/architecture/overviewguide/architecture/testing+contributing总行数:
README.md380 → 184,README_EN.md373 → 188。删除/新增统计:2 files changed, 34 insertions(+), 415 deletions(-)。README_EN.md额外增加一段顶部 blockquote,说明文档站当前仅维护简体中文以及推荐的阅读工作流(与 PR #192 中docs/en/index.md文案口径一致)。Test plan
Quality通过(prettier / eslint / tsc)README.md与README_EN.md渲染,确认 hero banner、badges、<details>折叠截图、移动端 2x2 截图表、跳链表均无样式漂移Related