Skip to main content
Use this glossary as a quick reference for terms used in Mintlify and throughout this documentation. For an overview of how the parts fit together, see Concepts.

A

Admin MCP server

An authenticated Model Context Protocol server that lets authorized AI tools read and update content and settings across one or more deployments in an organization. Changes happen on a branch and require a pull request to merge. See Admin MCP server.

Agent

An AI tool for documentation maintainers that researches, writes, validates, and publishes proposed changes. The agent can open a pull request or commit to the deployment branch, depending on your configuration. See Agent.

Anchor

A persistent top-level navigation link to an internal or external destination. Anchors are one of the primary navigation patterns available in docs.json. See Anchors.

Assistant

An AI interface for documentation readers that answers questions from your content. It cites relevant pages and can navigate users directly to the relevant content. The assistant does not edit your documentation. See Assistant.

Automation

A configured agent task that runs on a schedule, after a repository update, or in response to an event from a connected integration. See Automations.

B

Branch

A separate line of work in a Git repository. Use branches to make and review changes without affecting the live site. See Git concepts.

Build

The process that validates your project files and turns them into a deployable documentation site. A build can produce the live site or a preview deployment.

C

Commit

A saved snapshot of changes in a Git repository. Publishing from the web editor creates a commit. See Git concepts.

Component

A reusable MDX element for presenting structured or interactive content, such as a card, callout, accordion, tab, or code group. See Components.

Content directory

The directory in a repository that contains docs.json and the files for a Mintlify deployment. It can be the repository root or a configured subdirectory, such as docs/ in a monorepo. See Monorepo setup.

Context repository

An additional repository that the agent can read for background information when it performs a task. A context repository does not become part of the documentation site.

Credits

Units that measure use of Mintlify AI features. Credits are pooled across an organization and shared by its deployments and members. See Credits.

Custom domain

A domain, subdomain, or subpath that you connect to a Mintlify site instead of using its default .mintlify.site address. See Custom domain.

D

Dashboard

The authenticated Mintlify application where your team edits content, monitors deployments, manages members, and configures project and organization settings.

Deployment

A documentation project within a Mintlify organization. A deployment connects source content and a deployment branch to a live site. The term can also refer to a specific build being published.

Deployment branch

The Git branch used to build the live site, typically main. Changes pushed or merged into this branch trigger a production deployment. See Deployment branch.

docs.json

The required configuration file for a Mintlify site. It controls navigation, appearance, integrations, API settings, redirects, and other global behavior. See docs.json. A top-level navigation structure that groups related sections in a menu. See Dropdowns.

E

Editor

The browser-based editor in the Mintlify dashboard. It provides collaborative editing, automatic saving, live previews, Git synchronization, and publishing workflows. See Editor overview.

F

Feature branch

Any branch other than the deployment branch that you use to prepare changes. Feature branches keep unfinished work separate from the live site.

Frontmatter

YAML metadata at the beginning of an MDX page, enclosed by --- lines. Frontmatter controls properties such as the page title, description, icon, and layout. See Pages.

G

Group

A labeled collection of pages or nested groups in the sidebar. Groups organize related content within a navigation section. See Groups.

I

Index

A search service for coding agents that retrieves current technical context from publisher-maintained documentation and the web through an MCP server or REST API. See Index.

Integration

A connection between Mintlify and another service. Integrations can provide analytics, chat, privacy controls, SDK examples, automation context, or automation triggers.

L

Language

A locale-specific version of your documentation configured in navigation. Languages create locale-based routes and a language switcher. See Languages.

Live preview

The continuously updated rendering of your unpublished edits inside the web editor. A live preview is not publicly deployed. See Live preview.

Live site

The production documentation site built from the deployment branch and available to readers at a Mintlify or custom domain.

llms.txt

A generated text file that helps AI tools discover the most useful pages in a documentation site. llms-full.txt includes the content of all pages in one file. See llms.txt.

M

Markdown

A plain-text syntax for formatting content with elements such as headings, lists, links, and code blocks. Published Mintlify pages are also available as Markdown by appending .md to their URL.

MDX

Markdown extended with JSX. Mintlify uses .mdx page files so you can combine standard Markdown with components and custom React elements.

Merge

The Git operation that combines changes from one branch into another. Merging a feature branch into the deployment branch publishes its changes through a new build.

Model Context Protocol (MCP)

An open protocol that lets AI applications connect to tools and data sources. Mintlify offers a read-only public MCP server for each published site and an authenticated admin MCP server for managing deployments.

N

The hierarchy readers use to move through a documentation site. Configure navigation in your docs.json file with pages, groups, tabs, dropdowns, products, versions, languages, and anchors. See Navigation.

O

OpenAPI

A standard format for describing HTTP APIs. Mintlify can generate endpoint pages, request examples, and an interactive API playground from an OpenAPI document. See OpenAPI setup.

Organization

A Mintlify workspace that contains team members, organization-level settings, shared credits, and one or more deployments.

P

Page

An .mdx file that renders as a route on your documentation site. A page combines frontmatter, Markdown content, and optional components. See Pages.

Preview deployment

A temporary, shareable version of a site built from a pull request or selected branch. It lets reviewers inspect changes before they reach the live site. See Preview deployments.

Product

A top-level navigation structure for publishing documentation for multiple distinct products in one deployment. Each product has its own navigation. See Products.

Project

A general term for a Mintlify deployment and its connected repository, configuration, and site. In dashboard settings and APIs, deployment is usually the more specific term.

Publish

To write documentation changes to Git so they can progress toward the live site. Depending on the branch and review settings, publishing can deploy directly, save a commit to a branch, or create a pull request.

Pull request

A proposal to merge changes from one Git branch into another. Pull requests support review, discussion, automated checks, and preview deployments before changes reach the deployment branch. GitLab calls this a merge request.

R

Redirect

A rule that sends visitors from an old or alternate URL to a new destination. Redirects preserve working links when content moves. See Redirects.

Repository

A collection of files and their Git history. The documentation repository is the source of truth for a Mintlify site and contains its pages, configuration, and assets.

Reusable snippet

Content stored in a separate file and imported into one or more MDX pages. Updating the source snippet updates every page that uses it. See Reusable snippets.

S

skill.md

A generated file that describes a product’s capabilities and documentation for AI agents. Users can install it as an agent skill to improve results when working with the product. See skill.md.

Source repository

The repository that contains the product code, API definitions, or other material described by the documentation. The agent can use a connected source repository as context without publishing its files on the documentation site.

T

Tab

A top-level navigation section for parallel areas of documentation that serve the same audience, such as guides and API reference. See Tabs.

Theme

The base layout and visual system for a documentation site. A theme controls the overall presentation, while colors, fonts, logos, and other settings customize it. See Themes.

V

Version

A navigation structure for publishing multiple versions of the same documentation in parallel, such as v1 and v2. See Versions.