Skip to content
Documentation

Sync Check

updated

The sync check runs on a pull request and tells you, before merging, whether its documentation will sync cleanly. It reports as a GitHub check named Meldoc sync: <project-alias>. It checks how documents and meldoc.config.yml will sync — conflicts, front matter, links — not what they say; that is the Documentation Review.

It is switched on by default when you connect a repository from the project’s Repositories tab, and can be changed on the repository’s card. Project administrators only.

What it reports

Result When
Success The merge is clean, or touches no document of this project
Failure A conflict with edits made in Meldoc, a removed file whose document was edited in Meldoc, or front matter that doesn’t parse
Neutral It couldn’t answer — usually meldoc.config.yml is missing or unreadable — or only part of a very large pull request was checked

Broken [[alias]] links and missing files or images are warnings: the documents still sync. Problems appear as annotations at the file and line, and in a pull request comment shared with the documentation review, each with what to do. Nothing is written to Meldoc while the check runs.

Which pull requests it checks

Pull requests into the default branch are always checked. Under Check pull requests into on the repository’s card, add Every branch or patterns like develop or release/*. Pull requests from forks are not checked.

Making it required

You can mark the check required in GitHub branch protection. A pull request with no documentation changes still gets a green Nothing to check. If you later turn the check off, update the rule in GitHub first, or pull requests will wait forever. Before October 2026 the check was named Meldoc: <project-alias>.

What’s next?

Resolve a Conflict — Settle a conflict after the merge.

Documentation Review — Check whether a change makes the docs untrue.