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>
110 lines
8.3 KiB
Plaintext
110 lines
8.3 KiB
Plaintext
---
|
|
title: "Concepts"
|
|
description: "Comprenez comment Mintlify relie votre organisation, votre référentiel de documentation, vos workflows d'édition, vos déploiements et vos fonctionnalités d'IA."
|
|
keywords: ["concepts", "fonctionnement de Mintlify", "référentiel", "déploiement", "publication", "IA"]
|
|
---
|
|
|
|
Mintlify transforme le contenu d'un référentiel Git en un site de documentation. Vous pouvez travailler depuis l'éditeur dans votre navigateur, votre environnement de développement local, ou en interrogeant l'agent Mintlify dans Slack. Ces trois workflows mettent à jour le même référentiel. Mintlify compile le contenu de votre référentiel en expériences optimisées pour les personnes et les agents.
|
|
|
|
```mermaid
|
|
flowchart LR
|
|
Editors["Browser editors, local editors, and Mintlify agent"] --> Repo[("Documentation repository")]
|
|
Repo --> Build["Build and deployment"]
|
|
Build --> Site["Live documentation site"]
|
|
Site --> Readers["People"]
|
|
Site --> AI["AI agents"]
|
|
```
|
|
|
|
<div id="organizations-deployments-and-sites">
|
|
## Organisations, déploiements et sites
|
|
</div>
|
|
|
|
Une **organisation** est l'espace de travail de votre équipe. Elle contient vos membres, les paramètres au niveau de l'organisation, et un ou plusieurs déploiements.
|
|
|
|
Un **déploiement** est un projet de documentation dans votre organisation. Il connecte un référentiel, un répertoire de contenu et une branche de déploiement à un site publié. Une organisation peut avoir plusieurs déploiements pour des produits distincts ou différentes propriétés de documentation.
|
|
|
|
Un **site en ligne** est le résultat publié d'un déploiement. Mintlify fournit par défaut une URL `.mintlify.site`. Vous pouvez connecter un [domaine personnalisé](/fr/customize/custom-domain) à votre site. Les sites incluent votre contenu, votre navigation, la recherche et toutes les fonctionnalités que vous activez, comme l'assistant ou le playground d'API.
|
|
|
|
<Note>
|
|
La documentation utilise parfois **projet** comme nom générique pour un déploiement et son référentiel, sa configuration et son site associés.
|
|
</Note>
|
|
|
|
<div id="the-repository-is-the-source-of-truth">
|
|
## Le référentiel est la source de vérité
|
|
</div>
|
|
|
|
Votre référentiel de documentation contient les fichiers qui définissent votre site. Mintlify lit ces fichiers à chaque build.
|
|
|
|
- Les **pages** sont des fichiers `.mdx`. Chaque page contient du contenu et des métadonnées de frontmatter.
|
|
- `docs.json` est le fichier de configuration obligatoire. Il contrôle la navigation, l'apparence, les intégrations, les paramètres d'API et d'autres comportements applicables à l'ensemble du site.
|
|
- Les **ressources** incluent les images, vidéos, polices et fichiers téléchargeables référencés par vos pages.
|
|
- Les **spécifications d'API** peuvent générer des pages de référence d'API et des playgrounds interactifs à partir de schémas OpenAPI, AsyncAPI ou GraphQL.
|
|
- Les **fichiers réutilisables** incluent les snippets et les composants React personnalisés que les pages peuvent importer.
|
|
|
|
Votre référentiel peut contenir des fichiers non publiés. Une page apparaît dans la navigation du site uniquement lorsque vous la référencez dans la navigation de votre [`docs.json`](/fr/organize/navigation), sinon elle est masquée. Les [pages masquées](/fr/organize/hidden-pages) ne sont accessibles que par un lien direct.
|
|
|
|
<div id="pages-and-navigation-are-separate">
|
|
## Les pages et la navigation sont distinctes
|
|
</div>
|
|
|
|
Une **page** fournit le contenu à une URL. Son [frontmatter](/fr/organize/pages) contrôle les métadonnées et le comportement au niveau de la page, notamment son titre, sa description, son icône et sa mise en page.
|
|
|
|
La **navigation** détermine la façon dont les lecteurs se déplacent d'une page à l'autre. Configurez la navigation dans votre fichier `docs.json` en utilisant des éléments tels que les groupes, les onglets, les listes déroulantes, les produits, les versions et les langues. Le chemin du fichier identifie une page et sa position dans `docs.json` détermine son emplacement dans la navigation.
|
|
|
|
Cette séparation vous permet de réorganiser l'expérience du lecteur sans déplacer les fichiers. Elle vous permet également d'exclure les pages utilitaires de la navigation tout en les gardant accessibles par URL.
|
|
|
|
<div id="editing-and-publishing-are-different-stages">
|
|
## L'édition et la publication sont des étapes distinctes
|
|
</div>
|
|
|
|
Vous pouvez modifier le même contenu via deux workflows principaux.
|
|
|
|
| Workflow | Où vous éditez | Comment les modifications parviennent à Git | Comment vous prévisualisez |
|
|
| --- | --- | --- | --- |
|
|
| Éditeur | Dashboard Mintlify dans votre navigateur | L'éditeur crée des commits et peut ouvrir des pull requests | Aperçu en direct dans l'éditeur |
|
|
| Développement local | Votre éditeur préféré | Vous validez et poussez avec Git | Commande CLI `mint dev` |
|
|
|
|
Dans l'éditeur, les modifications sont **enregistrées** automatiquement mais ne mettent pas immédiatement à jour votre référentiel ou votre site en ligne. Lorsque vous **publiez**, l'éditeur écrit les modifications dans Git. Ce qui se passe ensuite dépend de votre branche actuelle et des paramètres de protection de branche.
|
|
|
|
- Sur la **branche de déploiement**, la publication peut déclencher directement un build du site en ligne.
|
|
- Sur une **branche de fonctionnalité**, la publication peut enregistrer les modifications sur la branche ou créer une pull request pour relecture.
|
|
- Un **déploiement de prévisualisation** rend une pull request sur une URL temporaire afin que les relecteurs puissent inspecter le résultat avant la fusion.
|
|
- La fusion d'une pull request dans la branche de déploiement déclenche un déploiement en production.
|
|
|
|
Consultez [Branching et publication](/fr/editor/publish) pour le workflow complet.
|
|
|
|
<div id="a-build-turns-source-files-into-reader-experiences">
|
|
## Un build transforme les fichiers source en expériences pour les lecteurs
|
|
</div>
|
|
|
|
Lorsque le contenu atteint la branche de déploiement, Mintlify valide le projet, rend les pages et déploie le site. Le même contenu source prend en charge plusieurs manières de trouver et de consommer l'information :
|
|
|
|
- Le site de documentation affiche les pages pour les personnes sur ordinateur et mobile.
|
|
- La recherche indexe le site afin que les lecteurs puissent trouver les pages pertinentes.
|
|
- L'assistant répond aux questions à partir de la documentation et cite ses sources.
|
|
- Les versions Markdown des pages, `llms.txt` et `skill.md` aident les outils d'IA à comprendre le contenu.
|
|
- Un serveur MCP public permet aux outils d'IA compatibles de récupérer la documentation sous forme de contexte structuré.
|
|
|
|
Exécutez [`mint validate`](/fr/cli/commands#mint-validate) et [`mint broken-links`](/fr/cli/commands#mint-broken-links) avant de publier pour détecter les problèmes courants en local.
|
|
|
|
<div id="mintlifys-ai-features-have-different-roles">
|
|
## Les fonctionnalités d'IA de Mintlify ont des rôles différents
|
|
</div>
|
|
|
|
Mintlify propose des fonctionnalités d'IA distinctes pour la lecture, l'écriture, l'automatisation et l'accès aux outils externes.
|
|
|
|
| Fonctionnalité | Utilisée par | Objectif | Modifie le contenu |
|
|
| --- | --- | --- | --- |
|
|
| [Assistant](/fr/assistant) | Lecteurs de la documentation | Répond aux questions à partir de votre contenu | Non |
|
|
| [Agent](/fr/agent) | Mainteneurs de la documentation | Recherche et propose des mises à jour de contenu ou de configuration | Oui |
|
|
| [Automatisations](/fr/automations/index) | Mainteneurs de la documentation | Exécute l'agent selon un planning, une mise à jour du référentiel ou un événement d'intégration | Oui |
|
|
| [Serveur MCP de recherche](/fr/ai/model-context-protocol) | Agents | Récupère le contexte à partir d'un site de documentation publié | Non |
|
|
| [Serveur MCP admin](/fr/ai/mintlify-mcp) | Agents | Lit et met à jour les déploiements via des outils authentifiés | Oui |
|
|
| [Mintlify Index](/fr/search-index) | Agents | Récupère le contexte technique actuel sur tous les sites publics Mintlify et sur le web | Non |
|
|
|
|
<div id="learn-the-terminology">
|
|
## Apprenez la terminologie
|
|
</div>
|
|
|
|
Consultez le [glossaire](/fr/reference/glossary) pour les définitions des termes Mintlify, Git, de publication, de navigation, d'API et d'IA utilisés dans l'ensemble de la documentation.
|