Skip to content

Commit 421c191

Browse files
lianlianclaude
andcommitted
docs(tools): 更新 check_links.py 排除列表和文档说明
## 主要变更 ### 1. 更新 tools/check_links.py 排除列表 (L294-327) **移除不存在的文件** (5个): - `docs/contributing/技术约定.md` → 已更名为 `technical-conventions.md` - `docs/contributing/编写规范.md` → 已更名为 `writing-guidelines.md` - `docs/contributing/PR流程.md` → 已更名为 `pr-workflow.md` - `docs/dev/FRONTEND_ARCHITECTURE.md` → 已删除 - `docs/pdf_export/README_pdf_output.md` → 路径错误 **新增应排除的文件** (16个): - 模板和示例: `404.md` - Contributing 指南: `index.md`, `academic-citation.md`, `clinical-guidelines.md` - 开发文档: `MIGRATION_REPORT.md`, `IMPROVEMENT_SUGGESTIONS.md` - 工具文档: `pdf_export/ignore.md` - README 文件: `tools/README.md`, `admin/README.md`, `assets/README.md` 等 (5个) **统计**: - 排除文件数: 10 → 21 (+11) - 实际检查文件数: 252/273 (92.3%) ### 2. 更新 docs/tools/README.md 文档说明 (L273-303) **新增内容**: - 📋 排除列表分类说明 (模板/指南/开发/工具/README) - 🔧 如何修改排除列表的指导 (含代码示例和行号链接) - ⚠️ 更新后的注意事项 (路径格式、验证要求) ## 验证结果 - ✅ 所有排除列表中的文件均存在 - ✅ 脚本运行正常,测试通过 - ✅ 文档引用准确 (行号、链接正确) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 1726c55 commit 421c191

File tree

2 files changed

+55
-12
lines changed

2 files changed

+55
-12
lines changed

docs/tools/README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,11 +270,36 @@ Markdown 链接规范检查
270270
- ✅ 如果检查不通过,CI 会失败并阻止提交
271271
- ✅ 显示详细的错误信息和修复提示
272272

273+
**排除列表配置:**
274+
275+
脚本默认排除以下类型的文件(可能包含示例链接或待完善内容):
276+
277+
1. **模板和示例文件**: `TEMPLATE_ENTRY.md``404.md`
278+
2. **Contributing 指南**: `contributing/` 下的所有规范文档
279+
3. **开发文档**: `dev/INDEX_GUIDE.md``dev/MIGRATION_REPORT.md`
280+
4. **工具文档**: `tools/REFACTORING_PLAN.md``pdf_export/` 相关文档
281+
5. **README 文件**: 各目录下的 `README.md`
282+
283+
如需添加新的排除文件,请编辑 [tools/check_links.py:294-327](../../tools/check_links.py#L294-L327) 中的 `exclude_files` 集合:
284+
285+
```python
286+
exclude_files = {
287+
# 模板和示例文件(包含示例链接)
288+
"docs/TEMPLATE_ENTRY.md",
289+
"docs/404.md",
290+
291+
# Contributing 指南(包含规范和示例)
292+
"docs/contributing/index.md",
293+
# ... 更多文件
294+
}
295+
```
296+
273297
**注意事项:**
274298

275299
- ⚠️ 脚本会递归检查指定目录下的所有 `.md` 文件
276300
- ⚠️ 自动排除 `node_modules``.git``venv` 等目录
277-
- ⚠️ 文档示例文件(如 `TEMPLATE_ENTRY.md`)默认��排除
301+
- ⚠️ 排除列表中的路径使用相对于仓库根目录的相对路径
302+
- ⚠️ 更新排除列表后建议运行测试确保所有文件存在
278303
- 💡 建议在提交前本地运行此工具,避免 CI 失败
279304

280305
---

tools/check_links.py

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -292,20 +292,38 @@ def find_md_files(root: Path, exclude_dirs: Set[str] = None, exclude_files: Set[
292292

293293
if exclude_files is None:
294294
exclude_files = {
295-
# 文档示例和说明文件(包含示例链接)
296-
"docs/contributing/技术约定.md",
297-
"docs/contributing/编写规范.md",
298-
"docs/contributing/PR流程.md",
295+
# 模板和示例文件(包含示例链接)
299296
"docs/TEMPLATE_ENTRY.md",
300-
# 迁移和计划文档
301-
"tools/pdf_export/MIGRATION_NOTES.md",
302-
"tools/REFACTORING_PLAN.md",
303-
# 开发文档
297+
"docs/404.md",
298+
299+
# Contributing 指南(包含规范和示例)
300+
"docs/contributing/index.md",
301+
"docs/contributing/technical-conventions.md",
302+
"docs/contributing/writing-guidelines.md",
303+
"docs/contributing/pr-workflow.md",
304+
"docs/contributing/academic-citation.md",
305+
"docs/contributing/clinical-guidelines.md",
306+
307+
# 开发文档(可能包含示例或待完善的链接)
304308
"docs/dev/INDEX_GUIDE.md",
305-
"docs/dev/FRONTEND_ARCHITECTURE.md",
306-
# 其他可能包含示例的文档
309+
"docs/dev/MIGRATION_REPORT.md",
310+
"docs/dev/IMPROVEMENT_SUGGESTIONS.md",
311+
312+
# 工具和计划文档
313+
"tools/REFACTORING_PLAN.md",
314+
"tools/pdf_export/MIGRATION_NOTES.md",
315+
"tools/pdf_export/README_pdf_output.md",
316+
"tools/pdf_export/ignore.md",
317+
318+
# 元数据文档
307319
"docs/changelog.md",
308-
"docs/pdf_export/README_pdf_output.md",
320+
321+
# README 文件(通常包含示例或外部链接)
322+
"docs/tools/README.md",
323+
"docs/admin/README.md",
324+
"docs/assets/README.md",
325+
"docs/assets/uploads/README.md",
326+
"tools/deprecated/README.md",
309327
}
310328

311329
md_files = []

0 commit comments

Comments
 (0)