How a Sync Runs
updated
A run is one sync pass between a repository and a project. The project’s Repositories tab lists runs, newest first.
What starts one
A run starts when something lands on the repository’s default branch, on a regular schedule, or when you select Sync now or Push to repository.
Run statuses
| Status | What it means |
|---|---|
| Queued / Running | Waiting or in progress |
| Succeeded | Everything synced |
| Finished with conflicts | Some documents need a decision — see Resolve a Conflict |
| Finished with warnings | Something did not arrive — read the warnings under the badge |
| Unfinished | A large change is continued in the next run; nothing is lost or deleted |
| Failed | Could not complete |
Edits made in Meldoc
Edits made in Meldoc go out as a single open pull request on the branch meldoc/sync/<project-alias>. Later edits are added to the same pull request; once you merge it, the next edit opens a new one. Each document’s History links to the pull request or commit its changes came from.
They are exported on the regular schedule, every few minutes, not the moment you save. Until then the repository’s card says how many documents are waiting and when the next export runs; select Push to repository to send them right away.
Deletions, moves and renames
- A file removed from the repository deletes or archives its document, following the project’s Documents deleted via CLI setting — see Archiving Documents. If the document has unsynced Meldoc edits, it becomes a conflict instead.
- Moving or renaming a file keeps the same document as long as its
aliasstays the same. Changing thealiasmakes it a different document. - Archiving a document in Meldoc removes its file from the repository.
Several repositories, one project
A project can be fed from several repositories. Give each repository a scope in its meldoc.config.yml so it only syncs its own part of the tree:
workspaceAlias: acme
baseDirs:
- projectAlias: platform
baseDir: docs
scope:
- postal
Without a scope, every repository syncs the whole project. See Configuration.
Images
Referenced images are uploaded as assets. If one cannot be fetched, the document is still imported with a warning.
What’s next?
Resolve a Conflict — When both sides changed the same file.
Sync Check — See what a sync will do before the pull request merges.