mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
693dbc361f
* Fix Vale style warnings across docs from past week of merges Generated-By: mintlify-agent * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
70 lines
4.0 KiB
Plaintext
70 lines
4.0 KiB
Plaintext
---
|
|
title: "Git essentials for the editor"
|
|
sidebarTitle: "Git essentials"
|
|
description: "Understand the Git version control concepts behind the Mintlify editor, including branches, commits, pull requests, and merge workflows."
|
|
keywords: ["git", "version control", "web editor", "branches", "commits", "pull requests", "PRs"]
|
|
---
|
|
|
|
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.
|
|
|
|
The web editor handles Git operations for you. Understanding a few key concepts helps you get the most out of the editor and collaborate effectively with your team.
|
|
|
|
## What Git does for your docs
|
|
|
|
Git tracks every change made to your documentation. It records what changed, who changed it, when they changed it, and why. This means you can:
|
|
|
|
- See the full history of any page.
|
|
- Undo changes by reverting to a previous version.
|
|
- Work on updates without affecting your live site.
|
|
- Review changes before they go live.
|
|
|
|
Your documentation repository is the collection of files—and their history—that makes up your documentation site. The web editor connects to this repository to sync and publish your content.
|
|
|
|
## Key concepts
|
|
|
|
These are the Git concepts you'll encounter most often when using the web editor.
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Commit">
|
|
A saved snapshot of your changes at a specific point in time. Each commit includes a message describing what changed and creates a permanent record in your project history.
|
|
|
|
When you publish changes, the web editor creates a commit in your Git repository.
|
|
</Accordion>
|
|
<Accordion title="Branch">
|
|
A separate line of work in your repository. Sometimes called a **feature branch**.
|
|
|
|
Your live documentation builds from a **deployment branch**, usually called `main`. Other branches let you work on changes independently without affecting your live site. Nothing on a branch goes live until you merge it into your deployment branch with a pull request.
|
|
|
|
Switch between branches using the branch dropdown in the editor toolbar. If you have unpublished changes, the editor lets you bring them to the new branch or leave them on your current branch.
|
|
</Accordion>
|
|
<Accordion title="Deployment branch">
|
|
The branch that builds your live documentation site, typically called `main`. Changes merged into this branch automatically deploy to your site.
|
|
</Accordion>
|
|
<Accordion title="Pull request">
|
|
A proposal to merge changes from one branch into another. Pull requests let your team review and discuss changes before they go live.
|
|
|
|
When you publish changes on a feature branch (or when your repository requires pull requests), the web editor creates a pull request. Your team reviews and merges the pull request in your Git provider (GitHub or GitLab).
|
|
</Accordion>
|
|
<Accordion title="Merge">
|
|
Combining changes from one branch into another. After your team reviews and approves a pull request, merging the branch incorporates your changes into the deployment branch and publishes them.
|
|
</Accordion>
|
|
<Accordion title="Conflict">
|
|
Occurs when two branches have incompatible changes to the same files. The editor helps you resolve conflicts when they occur.
|
|
</Accordion>
|
|
<Accordion title="Diff">
|
|
A comparison showing the differences between two versions of a file. The editor shows a visual diff of your pending changes before you publish so you can review exactly what gets committed.
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## How the editor maps to Git
|
|
|
|
Every publish action in the web editor corresponds to a Git operation.
|
|
|
|
| Your action in the editor | Git operation behind the scenes |
|
|
|---|---|
|
|
| Edit a page | Changes auto-save to Mintlify servers (no Git commit yet) |
|
|
| Switch branches | Check out the selected branch |
|
|
| Publish on your deployment branch | Commit changes to your repository and trigger a deployment |
|
|
| Publish on a feature branch | Commit changes and create a pull request |
|
|
| External push or CLI update | Incoming changes sync into the editor automatically |
|