Skip to content

For engineers: an EkLine pull request or comment on your repository

If EkLine commented on your pull request or asked you to review a docs pull request, you can reply to it, ask it for changes, or have its settings changed.

Someone in your organization connected this repository to EkLine, so the Docs Agent can check code changes for their effect on your documentation. What you see depends on how it was started:

What you seeWhy
One comment from EkLine on your pull requestAutomatic PR review looked at your change. By default the agent posts nothing when no docs update is needed, a two or three line note when an update might be needed, and, when one is clearly needed, a comment that starts with @ekline-ai and starts the Docs Agent on the update. It posts at most one comment per pull request.
“EkLine Docs Agent is on it. Follow the session in EkLine Editor.” (on GitLab: “EkLine Docs Agent is working on this update.”)Someone mentioned @ekline-ai, or EkLine’s own comment did. The Docs Agent is working on the request.
A pull request titled docs: ..., with you as a reviewerThe Docs Agent drafted the docs change in your documentation repository. You were added because you wrote the source pull request, or because you are on the team’s default reviewer list.

Automatic PR review runs when a pull request is opened or marked ready for review, and on GitHub when a label is added or removed. It does not run again when you push new commits, and it looks at each pull request at most once. By default it skips draft pull requests, pull requests into branches other than the default branch, and common bots such as Dependabot and Renovate.

  • Mention @ekline-ai in a comment on the pull request, or in an inline review comment on GitHub. A mention inside code, a link or an email address does not count.
  • Ask a question and the Docs Agent answers in the thread. Ask for a docs change and it makes the edits and, by default, opens or updates a docs pull request.
  • To change EkLine’s own docs pull request, mention @ekline-ai in a comment on it. On GitHub this continues the session that opened it. On GitLab it starts a new session.
  • Review, merge or close the docs pull request as you would any other.

To get a reply, you need write or admin access to the repository, or membership of the GitHub organization. On GitLab you need the Developer role or higher. See How EkLine opens pull requests for what a docs pull request contains.

These settings are in EkLine, not in your repository. Ask the person who set EkLine up, or any member of your EkLine organization, to change them.

You want toChange this
Skip some pull requests, such as release branches, a bot, a no-docs label, or changes that only touch test filesThe repository’s review rules: Settings > Integrations > GitHub Integration (or GitLab Integration), then the Review rules icon on the repository.
Stop reviews of this repositoryTurn off Enable monitoring on the repository, or remove it from both repository lists.
Keep the comments but stop automatic docs pull requestsTurn off Auto-create documentation PRs in the repository’s review rules. If you don’t see it, contact support@ekline.io.
Stop being added as a reviewerSettings > Docs Agent > Reviewers: remove the name from Default reviewers, or turn off Auto-assign reviewer.
Stop scheduled docs pull requestsIn Automations, turn the automation’s card off, or clear Raise a pull request in its settings. See Automations.
Stop automatic PR review for the whole organizationContact support@ekline.io.

A review rule only affects reviews that have not run yet. To skip a pull request by label, add the label before the pull request is opened or marked ready for review.

For more, see Automatic PR review and GitHub pull requests.

Built on Potluck Docs, our open source template.