Skip to content
Documentation

Documentation Review

updated

The Sync Check asks whether a pull request will sync cleanly. The documentation review asks the other question: does this change make something the documentation says untrue? It reports as a GitHub check named Meldoc review: <project-alias>.

It is off by default. Switch it on per project when connecting a repository, or later on the repository’s card in the project’s Repositories tab. Project administrators only.

What it reports

Finding What it means
Removed name A document names something this pull request removed from the code.
Outdated sentence A sentence describes behaviour this change ends. It is quoted verbatim.
Maybe a removed name A removed name also appears in a document; read the sentence before trusting it.

Findings appear as annotations on the changed lines and in one pull request comment shared with the sync check. Edit doc opens the document’s file on the pull request’s branch.

The review never fails the merge: it reports success or neutral, to be read, not to gate. The comment updates on every push, keeps findings that are still open, and lists those resolved since the last run.

When a finding is wrong

Select Mark as wrong on a finding. The review stops reporting that sentence for this repository until the sentence is edited.

After the merge

Open findings move onto the documents in Meldoc, shown above the title:

State What it means
Code changed, doc didn’t Merged into the synced branch; the document needs a fix.
Changes after release Merged into another branch, such as develop; it becomes the state above when that branch reaches the synced branch.
Fix planned Someone selected Fix later.
Checked against code A merged pull request was reviewed and nothing was found.

A finding closes when the sentence is edited, or when you select All correct. The Code check tab of the project overview lists everything still waiting.

What it does not look at

Documents outside this project, code the pull request didn’t touch, test files, Markdown files in the repository, lockfiles, and documents the pull request edits itself. The check summary always says what was left out.

Requirements and cost

Judging meaning needs your workspace’s own AI Provider. Without one, only removed names are checked. Each run spends a bounded amount on your key, and the comment shows the cost. You pay your provider directly.

How reliable it is

It finds most outdated sentences and most of what it reports is right, but it is not a guarantee. To help it catch more:

  • Name things in code formatting — functions, settings, flags, environment variables, routes and directories as code. That is what ties a page to the code.
  • Fix what is already outdated first. The review reports what a pull request makes untrue, not what was already wrong. Bring the docs in line with the code once, and the review keeps them there.

Turning it off

The toggle asks for confirmation. If the check is required in branch protection, change the rule in GitHub first, or pull requests will wait forever. Before October 2026 the check was named Meldoc docs: <project-alias>.

What’s next?

Sync Check — Will the pull request sync cleanly?

GitHub Sync — How fixed pages reach Meldoc.