Prevent documentation drift
Documentation drift is the gap that opens each time a PR merges without a matching docs update. Two safeguards catch it:
| Safeguard | When it runs | What it does |
|---|---|---|
| Automatic PR review | When a PR opens | Analyzes the diff and triggers a docs update when EkLine detects documentation impact |
| Scheduled drift audit | On a cadence you set | Reviews recent code activity and fixes the highest-priority undocumented change |
Before you begin
Section titled “Before you begin”You need:
- Automatic PR review, which is on by default, and Automations. If you don’t see Automations in the sidebar, contact support@ekline.io.
- The EkLine GitHub App connected, with your docs repository selected under Where EkLine writes and the repository where code changes land selected under What else EkLine can read.
Step 1: Verify automatic PR review is enabled
Section titled “Step 1: Verify automatic PR review is enabled”Automatic PR review runs only on repositories that are selected and monitored. Confirm monitoring is on for the repository where code changes land.
-
Go to your EkLine dashboard.
-
Go to Settings > Integrations > GitHub Integration.
-
Find the repository where code changes land, under What else EkLine can read (or Where EkLine writes), and confirm its Enable monitoring toggle is on.
-
If the toggle is off, enable it. EkLine saves the change immediately.
By default, EkLine reviews pull requests into the repository’s default branch. It skips drafts and pull requests from common bots. It posts a comment when it finds docs impact. To change which pull requests it reviews, see review rules.
Step 2: See it detect a real change
Section titled “Step 2: See it detect a real change”To confirm automatic PR review works, open a pull request with a code change that affects your docs.
-
Open a pull request against a monitored repository. Use a change that clearly affects your docs, such as adding a new API endpoint, renaming a configuration option, or removing a deprecated feature.
-
Make sure the PR is ready for review and not a draft.
-
Wait about 30 seconds. EkLine reads the diff, title, and description. Then it compares the changes with your docs.
-
Check the PR comments. EkLine posts one of the following:
Result What it means No comment Low confidence: the change likely does not affect documentation Suggestion comment Medium confidence: EkLine suggests a docs update and mentions @ekline-aiso you can start it yourselfAuto-trigger comment High confidence: the comment starts the Docs Agent on the update. EkLine replies with a link to the session, and the agent opens a docs PR.
If EkLine posts a comment, automatic drift detection is working.
Step 3: Set up a weekly scheduled drift audit
Section titled “Step 3: Set up a weekly scheduled drift audit”Automatic PR review catches impact as PRs open. The drift audit catches what it missed: changes that merged before you connected EkLine, and changes it did not rate High.
-
Click Automations in the sidebar.
-
Find Docs Drift Review under the Accuracy tab, or enter its name in Search.
-
Click Set up on its card.
-
In Lookback window, enter how far back each run looks, for example
last 30 days, orlast 7 daysfor a tighter weekly cadence. The field starts empty, and the automation cannot turn on until you fill it in. -
Under Schedule, keep the default of every week on Monday at 9:00 AM, or change Repeat every, Repeat on and At. Monday morning is a common choice. It sweeps last week’s changes before your team starts new work.
-
Under Notifications, keep Raise a pull request checked, so the agent opens a PR with the docs fix.
-
Send a Slack notification is also checked. Enter your docs channel name, for example
docs-team, and the agent posts a run summary there each week. Or clear the checkbox. -
Click Turn on.
The Docs Drift Review card now shows its toggle on, and the automation runs at the next scheduled time.
Verify the setup
Section titled “Verify the setup”Confirm both safeguards are active:
- Enable monitoring is on for the repository where code changes land, in Settings > Integrations > GitHub Integration.
- The Docs Drift Review card on the Automations page has its toggle on.
To see the automation’s output, click Edit on its card and open the Runs tab. Under Recent runs, click a run’s start time to open the full Docs Agent session. To get a run before the first scheduled time, click Run now on the same tab.
Troubleshooting
Section titled “Troubleshooting”| Issue | Solution |
|---|---|
| EkLine never comments on PRs | Check that the GitHub App is installed on the repository. Check that the repository is selected under Where EkLine writes or What else EkLine can read, and that Enable monitoring is on. EkLine skips draft PRs by default, so mark them ready for review. A Low assessment posts no comment. |
| Auto-trigger fired but no docs PR appeared | The agent may still be working. Wait up to a minute, then open the session from the link in EkLine’s reply on the PR. If Auto-create documentation PRs is off in the repository’s review rules, the drafts wait in the editor instead. |
| An automation run shows Failed | On the automation’s Runs tab, click the run’s start time to open the full session. Common causes: the repository is no longer accessible, or there were no code changes in the audit window. |
| Docs PR from drift review is off-target | Comment on the docs PR and mention @ekline-ai with feedback. The agent resumes the session and pushes corrections. |
Next steps
Section titled “Next steps”- Automatic PR review: understand the confidence tiers and what each detection level means.
- Automations: explore the full template library for recurring documentation tasks.
- GitHub PR bot: trigger documentation sessions manually from a PR comment.
- Create documentation: generate READMEs, API references, and guides from your codebase.
Built on Potluck Docs, our open source template.