Skip to main content
Mintlify documentation lives in a Git repository. You can let the web editor handle Git for you or work locally in your preferred editor. If Git is new to you, expect a short adjustment period. This course covers only what you need to work on Mintlify docs: the core concepts, everyday tasks, and habits that keep a team moving. You can leave the rest of Git for later. The course starts with the few Git ideas you need, then walks through setup, publishing, review, and team collaboration.

​
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 Mintlify connects to your repository and publishes changes
  • 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. It’s especially useful if you’re used to tools such as Notion, Confluence, or Google Docs.

​
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. Set up your local environment — Install the tools you need, clone your repository, and run a local preview.
  6. Workflow overview — The primary Mintlify workflow from making a change to seeing it live, using both the web editor and the CLI.
  7. Best practices for branches — When to create a branch, how to name it, and how to manage it through to a merged change.
  8. Preview deployments — How to review the rendered site before merging a pull request.
  9. Collaborating with your team — How to work alongside writers, engineers, and product managers without stepping on each other’s toes.