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

Описание и применение

Бот автоматически анализирует слияния PR, генерирует заметку о влиянии на документацию и публикует её в комментарий, позволяя человеку быстро обновлять docs.

Задача

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.

Источник