How EkLine Works
EkLine helps developers automate and maintain documentation by integrating quality checks, automatic doc generation, and style guide enforcement into your workflow.
EkLine treats documentation like code. We lint your prose, enforce your style guide, and catch errors before they merge.
How EkLine works
Section titled “How EkLine works”EkLine provides two AI-powered tools for documentation:
Docs reviewer — quality assurance for docs
Section titled “Docs reviewer — quality assurance for docs”The Docs Reviewer agent runs in your CI/CD pipeline and reviews documentation changes in every Pull Request. It catches:
- Style violations — Active voice, sentence length, readability
- Grammar issues — Spelling, punctuation, syntax
- Terminology inconsistencies — Enforce product names, technical terms
- Structural problems — Heading hierarchy, link validity
When issues occur, EkLine posts inline comments directly on the PR. You can configure it to block merges until you resolve the issues.
Supported platforms: GitHub Actions, GitLab CI, Bitbucket Pipelines
Docs Agent — AI-powered documentation generation
Section titled “Docs Agent — AI-powered documentation generation”The Docs Agent analyzes your codebase and generates documentation automatically:
- API references from function signatures and types
- README files with project overviews
- Getting started guides for onboarding
Access it from the EkLine dashboard or directly in VSCode.
Configuration
Section titled “Configuration”EkLine is fully customizable. You can manage rules, have custom guidelines, implement AI rules, add company specific terminology, and configure your own dictionary for your documentation creation and review.
Integrations
Section titled “Integrations”| Platform | Use case | Guide |
|---|---|---|
| GitHub Actions | PR review automation | Setup guide |
| GitLab CI | MR review automation | Setup guide |
| Bitbucket Pipelines | PR review automation | Setup guide |
| VSCode | Real-time feedback + Docs Agent | Setup guide |
| CLI | Local checks, CI flexibility | Setup guide |
Support
Section titled “Support”- Email: support@ekline.io
- Dashboard: ekline.io/dashboard