mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
9a4ec7b557
* Fix editor docs accuracy, split media page, clear translation orphans
Accuracy fixes, each verified against mintlify/mint or mintlify/server:
- pages.mdx: "Editors and managers can restore them" -> "admins".
"Manager" is not a Mintlify role.
- index.mdx: publishing on a feature branch does not automatically open a
pull request; you choose commit-to-branch or PR. Contradicted the
branching page's own table.
- branching-and-publishing.mdx: preview deployments build when you open a
pull request, not on every branch save. Confirmed in gitlabWebhooks
(handleMergeRequestOpenEvent) and cruxWebhooks (keyed on reviewId).
tutorial.mdx was already correct.
- settings.mdx: rewritten against editor-settings-form.tsx. The panel has
four sections, not "two layers", and the entire Appearance section was
undocumented - including "Open live preview in new tab", which
live-preview.mdx already linked readers to. Corrected three setting
labels, noted that draft PRs default to on, added the 20,000-character
instruction limit.
- live-preview.mdx: link now resolves to /editor/settings#appearance.
De-bloat:
- Split the media section out of pages.mdx (172 lines, 15 subtopics) into
editor/media.mdx and added it to the nav.
- Trimmed index.mdx from 11 sidebar-duplicating cards to 4.
Translation orphans and redirects:
- Deleted 7 translated files whose English source was removed in April and
June. The translate automation never cleaned them up, and in PR #6062 it
wrote into es|fr|zh/editor/media.mdx 34 days after the English source was
deleted.
- Dropped /editor/media -> /editor/pages so it stops shadowing the
recreated page.
- Added /{es,fr,zh}/editor/publish, completing an English-only redirect.
- Added /editor/collaborate and its language variants. That page was
deleted in June with no redirect and has been a live 404 since.
mint broken-links clean, mint a11y clean, vale 0/0/0 on changed files.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* Restructure editor docs: 14 pages to 9, cut UI description
The editor section had grown to 14 pages, about 40% of which described
things a user can see on screen. The ratio was 105 field-enumeration
bullets to 42 procedural steps.
New structure, organized around what is invisible rather than what is
on screen:
Overview absorbs git-essentials (concepts + the Git mapping table)
Tutorial unchanged
Edit content absorbs media and navigation
Publish branch mechanics, conflicts, git sync, commit signing
Review previews, pull requests, approve and merge
Collaborate comments + suggestions + real-time editing
Editor agent trimmed
Settings absorbs configurations as a pointer
Keyboard shortcuts unchanged
Removed: git-essentials, media, navigation, live-preview, comments,
suggestions, configurations, branching-and-publishing. Added: publish,
review, collaborate.
configurations.mdx was the clearest cut. It was a 193-line field-by-field
mirror of the Site configurations panel, which is a third rendering of
information already in the docs.json schema and in organize/settings-*
(2,694 lines). It is now a short section in settings.mdx covering only
what is specific to editing configuration from the editor: real-time
sync, the SVG logo constraint, and the redirects interface.
Also cut: block actions, the minimap, code block options, right-click
menu enumerations, page settings field lists (already delegated to
/organize/pages), and most screenshots of self-evident controls.
1,320 to 848 body lines. Field-enumeration bullets 105 to 29.
English redirects added for all eight removed pages. Language variants
deliberately omitted: es/fr/zh still carry the old structure, so
redirecting those paths now would shadow pages that still exist there.
The translation automation should mirror this restructure; verify
afterward that no orphans remain.
Vale vocabulary widened rather than reworded around: autocommit(s|ed|ing)?,
autosav(e|es|ed|ing), dotfile(s)?.
mint broken-links clean, mint a11y clean, vale 0 errors on editor/.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* Correct keyboard shortcuts against the editor keymap
Verified every documented shortcut against the bindings in mintlify/mint
rather than inferring them. The app-level set is exhaustive:
mod+backslash, mod+i, mod+k, mod+s, mod+shift+period, mod+z, shift+mod+d,
shift+mod+s. Visual-mode bindings come from the Tiptap extensions.
- Cmd/Ctrl+Shift+F ("Switch between Navigation and Files tree") does not
exist. No such binding is registered anywhere in the dashboard. Replaced
with the real binding at that spot in the UI: Cmd/Ctrl+Shift+. toggles
"Show all files".
- Added Heading 5 and Heading 6. Heading.configure sets levels 1-6 and
preserves the parent Mod-Alt-N shortcuts; the table stopped at 4.
- Added Cmd/Ctrl+G for accordion group, bound in Accordions.tsx.
Confirmed correct and unchanged: Cmd+K search, Cmd+I agent, Cmd+Shift+S
mode toggle, Cmd+Shift+D diff, Cmd+\ sidebar, Cmd+Shift+M comment,
Cmd+Shift+E suggesting mode, Cmd+Shift+X strikethrough, Cmd+K link,
Cmd+Enter line break, Cmd+Shift+8 unordered list, and that source mode
runs Monaco.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* Document auto publish, drop the deprecated deploy branch lock
Auto publish is available to all deployments, so the settings panel shows
"Auto publish" rather than "Main branch autocommits". It is not just a
rename: when it is on, the editor hides the branch selector and the
Publish button entirely (TopBar returns null for both), so there is no
pending state and no review step. Documented that behavior in
settings.mdx and added a note at the top of publish.mdx, since that page
otherwise assumes a publish step exists.
The deployment branch lock was deprecated and removed, so it stays out of
the docs. It was already dropped from settings.mdx in the restructure.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* 💅
* copy edit index
* Fix editor docs I verified against dead code
Three claims traced to code that never mounts. Ethan confirmed the diff
shortcut does not work, which exposed the pattern.
- Removed Cmd/Ctrl+Shift+D for diff view. It is registered only at
SubBar/index.tsx:488, inside EditorSubBar, which is exported and
imported by nothing. There is no live diff shortcut; exitDiff exists
only as an onClick in EditorModeContextMenu.
- Source mode runs CodeMirror, not Monaco. SourceEditor resolves through
source-editor/index.tsx to editor-view.tsx, which imports
@codemirror/state and @codemirror/view. Monaco is used only by
EmbedModal. The shortcut rows themselves were correct: CodeMirror's
defaultKeymap and searchKeymap match VS Code for toggle comment, move
line, duplicate line, find, and add cursor above/below, all confirmed
against @codemirror/commands.
- Rewrote the left panel section of pages.mdx. The tabs are Home and
Publishing (EditorNavigationSidebarContents.tsx:62), not Navigation and
Files. The Navigation/Files switcher lives in the same dead SubBar
component. Home renders the workspace file tree including private
pages; Publishing renders the site navigation and site settings.
Confirmed by the e2e helper openPublishingNavigation, which queries the
Publishing tab by role against the running app.
Also corrected in that section: the tree hides docs.json, dotfiles,
extensionless files, all-caps Markdown, and css/js/jsx/mjs/cjs/pdf unless
Show all files is on; "unlisted" was an invented term, replaced with a
link to /organize/hidden-pages; and the folder menu item is "New page",
confirmed by e2e, not "New file".
Added four source-mode bindings that are real and undocumented: Cmd+B and
Cmd+I insert Markdown markers, Cmd+Option+Shift+[ and ] fold and unfold
all.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* copy edit pages
* copy edit publish
* copy edit review
* copy edit settings
* copy edit collaborate
* Updated mintlify pages
- Updated quickstart.mdx
Mintlify-Source: dashboard-editor
* copy edit keyboard shortcuts
* Updated mintlify pages
- Updated quickstart.mdx
Mintlify-Source: dashboard-editor
* Revert "Updated mintlify pages"
This reverts commit 8d1b50cbfc.
* Updated mintlify pages
- Updated quickstart.mdx
Mintlify-Source: dashboard-editor
* fix editor edits
* Mirror the editor restructure into es, fr, and zh
Brings all three translated sites onto the same nine-page structure as
English instead of waiting for the translate automation, which has a
documented history of leaving orphans behind.
Content:
- Deleted 21 orphans: branching-and-publishing, comments, configurations,
git-essentials, live-preview, navigation, and suggestions in each
language. None had an English source after the restructure.
- Added publish, review, and collaborate in each language.
- Rewrote index, pages, settings, agent, and keyboard-shortcuts to match
the current English content, including Home/Publishing tabs, CodeMirror
source mode, Show all files, and the restored Appearance section.
- Kept the existing conventions: es uses usted, fr uses vous, keywords and
product UI labels stay in English, and every heading is wrapped in a
<div id="english-slug"> so cross-language anchors resolve. Verified that
every English anchor exists in all three languages.
Navigation and redirects:
- es.json, fr.json, and zh.json now list the same nine pages as docs.json.
- Removed six locale redirects that would have shadowed the new publish
and collaborate pages once they existed.
- Added 21 locale redirects for the removed pages and retargeted the
destinations that pointed at them.
- Retargeted four /editor/configurations redirects that pointed at
#site-configurations, an anchor dropped in the settings rewrite.
- Rewrote stale links in changelog, authentication-setup, concepts, and
glossary across all three languages, since broken-links does not follow
redirects.
English fixes needed first, all caused by the settings restructure:
- Restored ## Appearance. Two pages link to #appearance, and its four
preferences were otherwise undocumented.
- Restored ## Create draft pull requests by default, which changelog
links to and which defaults to on.
- Promoted Main branch autocommits from ### to ##; it was nested under PR
instructions, and its warning named a setting no longer on the page.
- Retargeted publish.mdx from the removed #auto-publish anchor.
- Fixed a missing space in the settings page intro.
mint broken-links clean, mint a11y clean (1042 files), vale 0 errors,
all five JSON files valid.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
238 lines
10 KiB
Plaintext
238 lines
10 KiB
Plaintext
---
|
|
title: "Glossary"
|
|
description: "Definitions for Mintlify product, content, navigation, deployment, Git, API playground, and AI terminology used throughout the documentation."
|
|
keywords: ["glossary", "terms", "definitions", "terminology"]
|
|
---
|
|
|
|
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](/reference/concepts).
|
|
|
|
## A
|
|
|
|
### Admin MCP server
|
|
|
|
An authenticated [Model Context Protocol](#model-context-protocol-mcp) 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](/ai/mintlify-mcp).
|
|
|
|
### 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](/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](/organize/navigation#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](/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](/automations/index).
|
|
|
|
## 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](/guides/git-concepts#branch).
|
|
|
|
### 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](/guides/git-concepts#commit).
|
|
|
|
### Component
|
|
|
|
A reusable MDX element for presenting structured or interactive content, such as a card, callout, accordion, tab, or code group. See [Components](/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](/deploy/monorepo).
|
|
|
|
### 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](/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](/customize/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](/guides/git-concepts#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`](/organize/settings).
|
|
|
|
### Dropdown
|
|
|
|
A top-level navigation structure that groups related sections in a menu. See [Dropdowns](/organize/navigation#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](/editor).
|
|
|
|
## 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](/organize/pages).
|
|
|
|
## G
|
|
|
|
### Group
|
|
|
|
A labeled collection of pages or nested groups in the sidebar. Groups organize related content within a navigation section. See [Groups](/organize/navigation#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](/search-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](/organize/navigation#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](/editor/review#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`](/ai/llmstxt).
|
|
|
|
## 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
|
|
|
|
### Navigation
|
|
|
|
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](/organize/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](/api-playground/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](/organize/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](/deploy/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](/organize/navigation#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](/create/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](/create/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`](/ai/skillmd).
|
|
|
|
### 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](/organize/navigation#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](/customize/themes).
|
|
|
|
## V
|
|
|
|
### Version
|
|
|
|
A navigation structure for publishing multiple versions of the same documentation in parallel, such as `v1` and `v2`. See [Versions](/organize/navigation#versions).
|