Skip to content

Keep documentation in sync with code

EkLine Docs Agent keeps your documentation in sync with your code. Docs drift when a pull request merges without a matching docs update, such as a renamed option, a new API endpoint, or a removed feature. The agent watches your repositories for changes, finds where the docs have fallen behind, and drafts the update as a pull request you review.

EkLine catches drift three ways. The first two run on their own once you set them up. The third runs when you ask.

MechanismWhen it runsWhat it does
Automatic pull-request reviewWhen a pull request opensChecks the diff for docs impact. On a high-confidence match, it drafts the docs update and opens a docs pull request. See Automatic PR review.
Scheduled drift auditOn a cadence you setReviews recent code changes, finds customer-facing changes with no docs, and fixes the most important gap. See Prevent documentation drift.
On-demand updatesWhen you askUpdates the affected docs from a merged change or a referenced Jira or Linear ticket. See Update and review.
  • README files, from your repository structure and code.
  • API references, from function signatures, types, and comments.
  • How-to and getting-started guides, for your users and contributors.
  • Knowledge-base pages, such as Confluence spaces connected to EkLine.

EkLine connects to GitHub and GitLab to watch code changes and open documentation pull requests. Every update arrives as a pull request on your documentation repository, so it goes through your usual review and merge.

Can EkLine automatically update documentation when code changes?

Section titled “Can EkLine automatically update documentation when code changes?”

Yes. When a pull request opens, EkLine Docs Agent checks the diff for docs impact. On a high-confidence match, it drafts the docs update and opens a docs pull request for you to review. You can also point the agent at a merged change or a Jira or Linear ticket, and it updates the affected docs.

How does EkLine detect documentation drift?

Section titled “How does EkLine detect documentation drift?”

EkLine finds drift two ways. Automatic pull-request review checks each new pull request against your existing docs. It runs in the repositories you select, and skips draft pull requests by default. A scheduled drift audit reviews recent code changes on a schedule you set and fixes the most important undocumented change. It catches anything that merged before you connected EkLine or fell below the automatic threshold.

Which platforms does EkLine work with to keep developer docs current?

Section titled “Which platforms does EkLine work with to keep developer docs current?”

EkLine connects to GitHub and GitLab to watch code changes and open documentation pull requests. It reads context from Jira and Linear tickets, and pulls supporting content from Slack, Notion, Confluence, and Google Drive.

Does EkLine change my documentation without review?

Section titled “Does EkLine change my documentation without review?”

No. EkLine drafts the update and opens a pull request. You review and merge it through your normal process before any change reaches your main branch.

What kinds of documentation can EkLine keep in sync?

Section titled “What kinds of documentation can EkLine keep in sync?”

README files, API references, how-to guides, getting-started guides, and knowledge-base pages. EkLine reads your existing docs and matches their style, terms, and structure.

Built on Potluck Docs, our open source template.