From 6cae4ba3bbdf2d1fb376bbb4f84299f9ff958661 Mon Sep 17 00:00:00 2001 From: tukuaiai Date: Tue, 5 May 2026 01:49:37 +0800 Subject: [PATCH] docs: clean readme title preambles --- docs/README.md | 2 -- docs/concepts/README.md | 2 -- docs/philosophy/README.md | 2 -- docs/references/README.md | 2 -- docs/research/README.md | 2 -- scripts/check-doc-structure.py | 7 +++++++ 6 files changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/README.md b/docs/README.md index 1ae2894..26e44f8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,5 @@ # 知识库总索引 -> `docs/` 是本仓库的核心知识库入口,承载从零开始、核心概念、哲学模型、研究笔记和工程参考资料。 - ## 字多不看 - 新手先读 `getting-started/`,按网络环境、CLI 配置、开发环境和 Git 闭环推进。 diff --git a/docs/concepts/README.md b/docs/concepts/README.md index b1ad633..981981c 100644 --- a/docs/concepts/README.md +++ b/docs/concepts/README.md @@ -2,8 +2,6 @@ # 核心概念 -> `concepts/` 是 Vibe Coding 的核心概念手册,用一个线性文档承载问题求解、拼好码、系统构建、开发范式、语言层要素与递归自优化系统。 - ## 字多不看 - 本目录回答“先用什么概念理解问题”。 diff --git a/docs/philosophy/README.md b/docs/philosophy/README.md index 7982655..43cf980 100644 --- a/docs/philosophy/README.md +++ b/docs/philosophy/README.md @@ -3,8 +3,6 @@ # 哲学方法论 -> `philosophy/` 是哲学方法论、思维模型、编程哲学和底层认知模型的线性手册。 - ## 字多不看 - 本目录回答“为什么这样判断、如何减少幻觉、如何让复杂问题可描述、可推理、可验证”。 diff --git a/docs/references/README.md b/docs/references/README.md index 13b226c..78e52da 100644 --- a/docs/references/README.md +++ b/docs/references/README.md @@ -3,8 +3,6 @@ # 参考资料 -> `references/` 是工程实践、技术栈、模板、清单、质量门禁和可复用经验的线性手册。 - ## 字多不看 - 本目录回答“具体工程怎么组织、怎么选技术、怎么设置硬门禁”。 diff --git a/docs/research/README.md b/docs/research/README.md index d295b50..b6225ff 100644 --- a/docs/research/README.md +++ b/docs/research/README.md @@ -2,8 +2,6 @@ # 研究 -> `research/` 是新技术、新技术栈、优秀 repo、工程范式和工具趋势的短篇解析与判断笔记。 - ## 字多不看 - 本目录是“观察与判断区”。 diff --git a/scripts/check-doc-structure.py b/scripts/check-doc-structure.py index f27f72c..f32e157 100644 --- a/scripts/check-doc-structure.py +++ b/scripts/check-doc-structure.py @@ -132,6 +132,13 @@ def check_standard_readme_blocks(path: Path, text: str) -> list[str]: if len(positions) != len(STANDARD_README_BLOCKS): return errors + title_end = positions[0][1] + text[positions[0][1] :].find("\n") + if title_end < positions[0][1]: + title_end = len(text) + between_title_and_summary = text[title_end:positions[1][1]].strip() + if between_title_and_summary: + errors.append(f"{rel}: standard README block '字多不看' must immediately follow the top title") + previous_name, previous_pos = positions[0] for block_name, position in positions[1:]: if position <= previous_pos: