From 6f26d6d8ca7db4d9b75ab50164f70eeaf0796657 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 15 Apr 2026 18:23:56 +0000 Subject: [PATCH] Document automatic git sync for the web editor Generated-By: mintlify-agent --- editor/git-essentials.mdx | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/editor/git-essentials.mdx b/editor/git-essentials.mdx index 60967f11b..aeb164ad4 100644 --- a/editor/git-essentials.mdx +++ b/editor/git-essentials.mdx @@ -1,8 +1,8 @@ --- title: "Git essentials for the web editor" sidebarTitle: "Git essentials" -description: "Understand the Git version control concepts behind the Mintlify web editor, including branches, commits, pull requests, and merge workflows." -keywords: ["git", "version control", "web editor", "branches", "commits", "pull requests", "PRs"] +description: "Understand the Git version control concepts behind the Mintlify web editor, including branches, commits, pull requests, merge workflows, and automatic sync." +keywords: ["git", "version control", "web editor", "branches", "commits", "pull requests", "PRs", "sync", "auto-sync"] --- Git lets you control and track changes to files. Git is the version control system of choice for docs-as-code workflows where you manage documentation the same way you would any other codebase. @@ -67,3 +67,17 @@ Every action you take in the web editor corresponds to a Git operation. | Create a branch | Create a **branch**, a separate line of work that doesn't affect your live site unless you choose to publish it | | Publish on your deployment branch | Push your commit directly, which triggers a deployment | | Publish on a feature branch | Create a **pull request**, a proposal to merge your changes into the deployment branch | + +## Automatic sync with Git + +The web editor automatically keeps your documents in sync with your Git repository. When you open a page that has been updated in Git since your last edit, the editor fetches the latest version and merges the changes into your working document. + +This means you don't need to manually refresh or reload pages to see updates from teammates or CI pipelines that push directly to your repository. The editor handles this in the background using a three-way merge: + +1. The editor compares the **base version** (the Git state when you last opened or synced the file), your **current edits**, and the **latest version** from Git. +2. Changes that don't overlap are merged automatically. +3. Your unsaved edits are preserved alongside the incoming Git changes. + + + The editor syncs with Git each time a document is opened and periodically while it's active. If the file hasn't changed in Git, no sync occurs. +