chore: 清理冗余文档,减少上下文负担 #5
Merged
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.
📋 变更说明
问题
项目文档比代码还多,造成严重的上下文负担。很多文档只是重复了代码和配置文件中已有的信息,维护成本高且容易过时。
解决方案
删除 10 个冗余文档,共减少 25,000+ 行,只保留核心必需文档。
🗑️ 删除的文档
根目录 (5个文件)
MAKEFILE_GUIDE.md- Makefile 本身已有清晰注释和make helpSETUP_AUTO_FORMAT.md- 配置文件(.pre-commit-config.yaml、pyproject.toml)本身就是文档EXAMPLES.md(14,339 行!) - 超长示例文档,工具的 docstring 是更好的文档COMPLETION_REPORT.md- 开发过程文档,Git 历史已经记录了所有改动TASK.md- 任务计划,应该使用 GitHub Issues/Projects 管理.github 目录 (5个文件)
WORKFLOWS.md- workflow 配置文件(.github/workflows/*.yml)本身就是文档CODE_QUALITY.md- 工具配置文件本身就是文档BRANCH_PROTECTION.md- GitHub 设置说明,一次性文档,用完即丢CHECKLIST.md- 开发过程检查清单SETUP_SUMMARY.md- 安装总结,一次性文档文件重组
verify_completion.py→test_scripts/verify_completion.py(更合理的位置)✅ 保留的核心文档
根目录
README.md- 项目主文档(必需)CONTRIBUTING.md- 贡献指南(开源项目必需)LICENSE- 法律文件(必需).github 目录
.github/copilot-instructions.md- AI 编程指南(对 AI 辅助开发有实际价值).github/pull_request_template.md- GitHub PR 模板(GitHub 功能必需).github/ISSUE_TEMPLATE/*.md- GitHub Issue 模板(GitHub 功能必需)💡 核心理念
make help→ 不需要 MAKEFILE_GUIDE.md好处:
📊 统计
清理后: 文档与代码比例从 12:1 降低到 ~1:1(合理)
✅ 检查清单