How EkLine Docs Reviewer works
Docs Reviewer is EkLine’s check on every documentation change: it reviews the changed text against your style guide and comments on what to fix before the change merges.
What it checks
Section titled “What it checks”Docs Reviewer reports each issue with a rule ID, such as EK00031, a severity (suggestion, warning, or error), and a message that says what to change. Its rules cover:
- Spelling and grammar: typos, punctuation, repeated words, and American spelling.
- Tone and voice: active voice, present tense, and contractions.
- Consistency: product names and terms, dates, numbers, and units.
- Inclusive and respectful language.
- Headings and sentences: sentence-case headings, heading punctuation, and sentence length.
- Readability: Flesch-Kincaid and Gunning fog scores.
- Links: broken links and broken email addresses.
Each rule has its own page in the rules reference. Docs Reviewer can also review an OpenAPI spec for missing descriptions, missing constraints, and unused components.
Most rules give the same result on every run. AI also filters out likely false positives: in VS Code, in CI on every pull request or merge request, and in the CLI when you pass --ai-suggestions, which also adds AI suggestions.
It checks the change, whoever wrote it
Section titled “It checks the change, whoever wrote it”In a pull request or merge request, Docs Reviewer checks the added and changed lines, not who wrote them. Docs from a coding agent such as Claude Code, Cursor, Codex, or GitHub Copilot get the same rules and the same review comments as docs a person writes.
Where it runs
Section titled “Where it runs”| Where | What you see | Set up |
|---|---|---|
| GitHub Action | Review comments on the changed lines of a pull request, or results in GitHub Checks | Quickstart, full guide, run on a label |
| GitLab CI | Discussions on the merge request, or comments on each commit | GitLab CI |
| Bitbucket Pipelines | A review step on every pull request and on main | Bitbucket Pipelines |
| VS Code | Highlights when you open or save a file, with suggestions on hover. An AI assistant, Improve with EkLine AI, rewrites text you select or drafts new text | Quickstart, full guide |
| Google Docs | A list of issues in the EkLine Chrome extension, each with a suggested change you can accept | Google Docs |
| CLI | Issues in your terminal, or a .jsonl or .csv file | Quickstart, full guide |
Every setup except Google Docs uses your integration token from Settings > Organization > Access in the EkLine Dashboard. In Google Docs, you sign in from Extensions > EkLine.
Where to start
Section titled “Where to start”Choose by where your docs live:
- In a GitHub, GitLab, or Bitbucket repository: run it in CI, so every pull request or merge request gets checked.
- Written locally: add VS Code for feedback while you write, alongside a CI check.
- Outside a repository, such as specs and proposals: use Google Docs.
- Another CI system, or a check before you push: use the CLI.
Check your docs in CI compares the setups.
Configure it
Section titled “Configure it”Set your standard once, and every review uses it:
- Configuration file:
ekline.config.jsonat your repository root sets the folders to check, the style guide, the rules to ignore, and the files to exclude. Commit it so every pull request and every teammate uses the same settings. - Choose a style guide: Google (the default), Microsoft, or Marketing, or a custom standard.
- Dictionary: product names and jargon that the spell check accepts, saved in your EkLine account so every setup uses them.
- Framework support: checks the text inside MDX components for Mintlify, Astro, Fern, Docusaurus, and GitBook.
- OpenAPI spec review: reviews an OpenAPI 2.0, 3.0, or 3.1 file.
- Style-guide enforcement: the GitHub setup from start to finish, including blocking merges.
In the app, you can also turn individual rules on or off in Settings > Docs Agent > Reviewer Rules, and list terms to avoid, each with the term to use instead, in Settings > Organization > Terminology. After a change on either page, select Apply Configuration. Changes take effect within 5 minutes. These settings and your dictionary apply when a review uses your own standard, not a built-in style guide.
Docs Reviewer and the Docs Agent
Section titled “Docs Reviewer and the Docs Agent”The Docs Agent writes and updates docs, such as READMEs, API references, and guides. Docs Reviewer checks them. Use the two together: the agent drafts, and Docs Reviewer catches style, terminology, and formatting issues before the change merges.
Does it check whole files or only my changes?
Section titled “Does it check whole files or only my changes?”Only the added and changed lines, by default. To check every changed file in full, set filter_mode to file. The GitHub Action full guide lists every filter mode.
Can it block a merge?
Section titled “Can it block a merge?”Yes, on GitHub and GitLab. By default, Docs Reviewer posts its comments without failing the check.
- GitHub: add
reviewdog_flags: -fail-level=errorto the action’s inputs, so the job fails when Docs Reviewer reports an issue at error severity. Then make the workflow’s job a required check in your branch protection rule. See Style-guide enforcement. - GitLab: set
INPUT_REVIEWDOG_FLAGS: "-fail-level=error"in the job’s variables, then turn on Pipelines must succeed for the project. See Block merges until docs pass.
Can I add my own rules?
Section titled “Can I add my own rules?”You can turn rules on or off, add terms to avoid, and add words to your dictionary yourself. For a custom rule, contact support@ekline.io.
Is Docs Reviewer the same as Automatic PR review?
Section titled “Is Docs Reviewer the same as Automatic PR review?”No. Automatic PR review is a Docs Agent feature: it reads a code pull request and decides whether your docs need an update. Docs Reviewer checks the wording of the docs change itself.
Built on Potluck Docs, our open source template.