DevTools文档CI/CD开发者工具

DocRefFixer – 文档中的代码行引用自动修复

帮开发团队自动发现并修复文档里过期的 file:line 引用

痛点
很多项目的 README、架构文档、教程里大量引用具体文件路径和行号(如 `src/foo.ts:42`),一旦代码重构,这些引用就全部失效,读者跳转不到正确位置,维护者也很少有人定期检查。有 HN 帖子专门提到『找到并修复文档里过期的 file:line 引用』这个需求。
方案
做一个 CLI/CI 工具,扫描 Markdown、注释和文档中的 file:line 引用,与当前代码仓库比对,找出失效或指向错误内容的引用,并尝试通过符号匹配自动修正行号,输出可提交的 patch 或 PR。
用户
维护开源项目或内部技术文档的开发者、技术写作者,尤其是文档中大量引用代码行的团队。
MVP
解析 Markdown 与代码注释中的 file:line 格式引用;校验文件是否存在、行号是否越界、该行内容是否与引用上下文匹配;对失效引用给出建议行号并生成 diff;支持作为 CI 步骤运行,失败时输出报告;提供 GitHub Action 自动开修复 PR。
变现
开源核心 CLI 免费,GitHub App/CI 托管版按仓库数或私有仓库席位订阅(如 5-20 美元/月),企业版提供自托管与审计报告。
为何现在
AI 辅助编程让代码重构速度大幅加快,文档中代码引用的失效率显著上升,而现有工具几乎只检查链接,不检查 file:line 级别的内容漂移,是一个明显的缝隙。

来源讨论 · 1

  1. Hacker NewsShow HN: Linecite – find and fix stale file:line references in your docs1↑ 0
← 返回列表