Catch Docs Drift at the PR: A Free‑Tier Bot That Drafts Impact Notes

说明与用途

机器人分析合并的 PR，生成文档影响说明并发布为评论，提示人工更新文档。

问题

Documentation drift occurs when code changes are merged without updating docs, leading to runtime errors and user confusion.

结果

The bot reduces documentation drift by automatically flagging potential doc updates for every merged PR, keeping token usage predictable and requiring only a human to approve changes.

工作流

• Fetch merged PRs since last run
• Build prompt with PR title, changed files, and truncated diff
• Send prompt to free LLM and receive JSON with impact label, candidate doc files, and note
• Post the note as a comment on the PR or open a draft PR against docs
• Human reviews the note and decides whether to edit docs

证据

The bot runs on a schedule, not on every push. That keeps token spend predictable and the server stateless.

来源

The model returns a JSON classification: impact label, candidate doc files, and a short note.

来源

A typical small PR lands in the low thousands of input tokens. A large diff can exceed the context window and force truncation.

来源