Skip to main content

Documentation Index

Fetch the complete documentation index at: https://learn.mintlify.com/llms.txt

Use this file to discover all available pages before exploring further.

Documentation teams that use Mintlify work in Git. The web editor performs Git operations behind the scenes or you can work on your documentation locally to use whatever docs-as-code workflow you prefer. If you’ve never used Git before, this workflow can take a bit of time to get used to. This course strips it down to the key principles and tasks to become familiar with to get going with your documentation hosted on Mintlify. We definitely won’t get into the full scope of Git, just the concepts and habits that make a documentation workflow run smoothly. Each lesson builds on the previous one, from understanding why Git exists to collaborating with a full team on the same repository.

​
What you’ll learn

  • Why documentation teams use Git and what problems it solves
  • Core Git concepts that help you understand Mintlify’s docs-as-code workflow
  • How to connect your repository to Mintlify and get your site live
  • How to manage branches, use preview deployments, and collaborate with your team

​
Who this is for

Anyone who contributes to documentation on Mintlify and wants to understand the Git-based workflow, especially if you’re coming from a background in Notion, Confluence, or Google Docs where you used a different version control system.

​
Lessons in this course

  1. Why docs teams use Git — What problems Git solves for documentation teams, and why it’s worth learning.
  2. Core Git concepts — Concepts and commands that cover nearly everything you’ll do with your documentation repository.
  3. Get connected — How to create your documentation repository, install the Mintlify GitHub app, and get your site live.
  4. Access and permissions — The two permission systems that control who can do what: GitHub for repository access and Mintlify for site configuration.
  5. Workflow overview — The primary Mintlify workflow from making a change to seeing it live, using both the web editor and the CLI.
  6. Best practices for branches — When to create a branch, how to name it, and how to manage it through to a merged change.
  7. Preview deployments — How Mintlify generates a live preview for every pull request, and how to use it as part of your review process.
  8. Collaborating with your team — How to work alongside writers, engineers, and product managers without stepping on each other’s toes.