Skip to content

Automatic documentation review on pull requests

When you open a pull request, EkLine checks whether your docs need an update. It rates how sure it is. Then it stays silent, posts a suggestion, or starts a docs update for you.

flowchart TD
    A[Pull request opened] --> B[EkLine analyzes PR diff]
    B --> C{Documentation impact?}
    C -->|Low confidence| D[No action taken]
    C -->|Medium confidence| E[Posts suggestion comment]
    C -->|High confidence| F[Posts auto-trigger comment]
    F --> G[Docs update flow runs automatically]
    G --> H[Documentation PR created]
    E --> I[You decide whether to trigger]

EkLine checks a pull request when it is opened, marked ready for review, or has a label added or removed. It:

  1. Reads the PR diff, title, and description.
  2. Compares the changes with your docs.
  3. Decides whether the changes affect your docs.
  4. Acts on how sure it is.

Draft pull requests are skipped unless you turn off Skip draft PRs in the repository’s review rules.

EkLine puts each check into one of three tiers:

TierWhen it appliesWhat EkLine does
LowRefactoring, new tests, or bug fixes that users do not seeStays silent. Posts no comment.
MediumChanges in behavior that might affect a documented featurePosts a suggestion comment on the PR
HighNew API endpoints, renamed configuration, removed features, or changed public interfacesPosts a comment that starts the docs update

EkLine starts a docs update only when the impact is clear. When it is unsure, it stays silent.

EkLine posts a comment on the pull request that says which docs might need an update. The comment mentions @ekline-ai, so you can start the update yourself if you agree.

EkLine does nothing more. You decide whether to go ahead.

EkLine posts a comment that starts the GitHub PR bot flow. EkLine replies that the Docs Agent is on it, with a link to the session. The agent drafts the docs update and opens a docs pull request. If Auto-create documentation PRs is off in the repository’s review rules, the drafts wait in the editor instead. If no pull request appears, open the session from the link and ask the agent to open one.

Before automatic PR review works on your repositories, you need:

  • An EkLine organization account.
  • The EkLine GitHub App installed on the repository.
  • Automatic PR review on for your organization. It is on by default.
  • The repository selected in your GitHub integration settings, under either Where EkLine writes or What else EkLine can read. EkLine reviews pull requests only from repositories you selected. It skips PRs from other repositories the app can access. See Configure repositories.
  • Enable monitoring on for the repository. It is on by default.

Then it runs on the repositories you selected, for pull requests that pass each repository’s review rules.

ScenarioWhat appears on the PR
Low confidenceNothing. EkLine stays silent.
Medium confidenceA comment that suggests a docs update, with @ekline-ai mentioned so you can start it
High confidenceA comment that starts the docs update, then a reply with a link to the session. The agent then opens a docs PR.
Error during the checkNothing. EkLine stays silent.

At most one automatic review comment appears per pull request.

Automatic PR review builds on the GitHub PR bot:

  • Manual flow: You mention @ekline-ai in a PR comment to start a docs session.
  • Automatic flow: EkLine posts the @ekline-ai mention for you when the impact is clear.

Both flows start the same kind of docs session. If EkLine already posted an automatic comment and you then mention @ekline-ai on the same PR, the existing session resumes. No second session starts.

Automatic review also runs on GitLab merge requests, with these differences:

  • A merge request is reviewed when it is opened, reopened, or marked ready. Adding or removing a label, or pushing new commits, does not start a review.
  • EkLine needs the webhook and the access token from Connect GitLab.
  • Merge requests from dependabot, renovate, gitlab-bot, or any username ending in -bot are always skipped.
  • EkLine’s comments are posted as the GitLab user who owns the access token you connected.

You can also check a PR yourself with the /analyze-pr-for-docs-needs command in the EkLine Docs Agent. Give the PR URL as an argument:

/analyze-pr-for-docs-needs https://github.com/your-org/your-repo/pull/123

The agent compares the PR diff with your docs and uses the same confidence tiers. Use it to check a PR without waiting for the automatic review, or to check a PR again after large changes.

  • One check per PR: New commits pushed after the first check do not start a new one.
  • Fixed tiers: You cannot change the thresholds that decide whether EkLine stays silent, suggests, or starts an update. To control which pull requests EkLine reviews, use review rules.
  • PR context only: The check uses the PR diff, title, and description. It does not read linked Jira or Linear tickets.
  • This PR’s changes only: EkLine checks the changes in the PR. It does not look for gaps that were already in your docs.
IssueSolution
No comment appears on my PRCheck that the repository is selected in your GitHub integration settings, under Where EkLine writes or What else EkLine can read. Check that Enable monitoring is on for it. Check that the EkLine GitHub App is installed and automatic PR review is on for your organization. EkLine also skips draft PRs by default, PRs your review rules filter out, and PRs that already have a session. A Low check posts no comment.
EkLine posted a suggestion but I want the updateMention @ekline-ai in a new comment on the PR. Say which docs changes you need.
The auto-triggered docs PR is wrongComment on the docs PR, mention @ekline-ai, and give your feedback. The agent resumes the session and pushes new commits.
EkLine started an update on a PR that does not need docsThe check is best-effort. Close or ignore the docs PR.

Built on Potluck Docs, our open source template.