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>
132 lines
7.0 KiB
Plaintext
132 lines
7.0 KiB
Plaintext
---
|
|
title: "Réviser les modifications"
|
|
sidebarTitle: "Réviser"
|
|
description: "Prévisualisez vos modifications avant leur mise en ligne, partagez-les avec votre équipe, puis approuvez et fusionnez les pull requests depuis l'éditeur."
|
|
keywords: ["review", "preview", "live preview", "pull request", "approve", "merge", "diff"]
|
|
---
|
|
|
|
Prévisualisez vos modifications avant qu'elles n'atteignent votre site publié, puis révisez et fusionnez la pull request sans quitter l'éditeur.
|
|
|
|
<div id="live-preview">
|
|
|
|
## Aperçu en direct
|
|
|
|
</div>
|
|
|
|
L'aperçu en direct affiche votre site pendant que vous le modifiez, sans étape de compilation. Cliquez sur le bouton <Icon icon="play" /> d'aperçu en direct dans la barre supérieure.
|
|
|
|
Pour modifier les paramètres du site et voir leur effet sur votre contenu, cliquez sur **Site settings** dans la barre d'outils de l'aperçu, puis sélectionnez une section de configuration. Ce menu n'est pas disponible si vous avez activé [Open live preview in new tab](/fr/editor/settings#appearance).
|
|
|
|
Pour ouvrir l'[agent](/fr/editor/agent) à côté de l'aperçu, cliquez sur **Ask agent** dans la barre d'outils de l'aperçu. Seuls les editors et les admins peuvent utiliser l'agent dans les aperçus en direct.
|
|
|
|
<Note>
|
|
L'aperçu en direct fonctionne pour les sites publics et pour les sites protégés par l'authentification Mintlify.
|
|
</Note>
|
|
|
|
<div id="preview-deployments">
|
|
|
|
## Déploiements de prévisualisation
|
|
|
|
</div>
|
|
|
|
Lorsque vous ouvrez une pull request depuis une feature branch, Mintlify compile un déploiement de prévisualisation : une URL temporaire où vos modifications s'affichent exactement comme elles le seront une fois publiées. L'aperçu est recompilé chaque fois que vous enregistrez de nouvelles modifications sur la branch.
|
|
|
|
Pour trouver et partager l'URL, cliquez sur **Publish** dans la barre d'outils. Le format de l'URL est `organization-branch-name.mintlify.site`.
|
|
|
|
<Frame>
|
|
<img src="/images/editor/share-preview-light.png" alt="URL de prévisualisation mise en évidence dans le menu de publication." className="dark:hidden" />
|
|
<img src="/images/editor/share-preview-dark.png" alt="URL de prévisualisation mise en évidence dans le menu de publication." className="hidden dark:block" />
|
|
</Frame>
|
|
|
|
Les URLs de prévisualisation sont publiques par défaut. Pour en restreindre l'accès aux membres de votre organisation Mintlify, activez l'authentification des aperçus sur la page [Add-ons](https://app.mintlify.com/products/addons) de votre dashboard.
|
|
|
|
<div id="which-preview-to-use">
|
|
|
|
## Quel aperçu utiliser
|
|
|
|
</div>
|
|
|
|
| | Aperçu en direct | Déploiement de prévisualisation |
|
|
|---|---|---|
|
|
| **Rapidité** | Instantané | Nécessite une compilation |
|
|
| **Accès** | URL locale | URL partageable |
|
|
| **À utiliser quand** | Vous révisez des modifications en cours d'édition | Vous partagez avec votre équipe pour révision |
|
|
| **Disponibilité** | Tant que l'éditeur est ouvert | Tant que la branch existe |
|
|
|
|
<div id="share-an-editor-link">
|
|
|
|
## Partager un lien vers l'éditeur
|
|
|
|
</div>
|
|
|
|
Pour diriger un collègue vers une page précise d'une branch, copiez l'URL depuis la barre d'adresse de votre navigateur. Toute personne ayant accès à votre organisation Mintlify peut l'ouvrir dans sa propre session de l'éditeur.
|
|
|
|
```text
|
|
https://app.mintlify.com/{org}/{project}/editor/{branch}/~/{filepath}
|
|
```
|
|
|
|
Par exemple : `https://app.mintlify.com/acme/docs/editor/main/~/guides/quickstart.mdx`
|
|
|
|
<div id="review-and-merge-pull-requests">
|
|
|
|
## Réviser et fusionner les pull requests
|
|
|
|
</div>
|
|
|
|
Lorsqu'une pull request est ouverte pour la branch actuelle, le menu de publication affiche un panneau de révision avec :
|
|
|
|
- Le titre et la description de la pull request
|
|
- Les branches source et cible
|
|
- Le nombre de fichiers modifiés
|
|
- L'exigence d'approbation sur la deployment branch
|
|
- L'état actuel de la révision
|
|
|
|
Une fois qu'un relecteur a approuvé, cliquez sur **Merge and publish** pour fusionner et déployer depuis l'éditeur. L'éditeur vous ramène ensuite sur votre deployment branch.
|
|
|
|
<div id="approve-from-the-editor">
|
|
|
|
### Approuver depuis l'éditeur
|
|
|
|
</div>
|
|
|
|
Pour les dépôts GitHub, les relecteurs peuvent approuver les pull requests ouvertes sans quitter l'éditeur. Un bouton **Approve pull request** apparaît dans le panneau de révision si votre compte a le droit de la relire. L'état passe à **Approved** et **Merge and publish** devient disponible.
|
|
|
|
Si vous utilisez GitLab ou Bitbucket, ouvrez la pull request chez votre fournisseur Git pour l'approuver.
|
|
|
|
<Tip>
|
|
Configurez des règles de protection de branch chez votre fournisseur Git pour exiger des pull requests. Consultez [About protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) dans l'aide GitHub ou [Protected branches](https://docs.gitlab.com/user/project/repository/branches/protected/) dans l'aide GitLab.
|
|
</Tip>
|
|
|
|
<div id="compare-changes-before-merging">
|
|
|
|
### Comparer les modifications avant de fusionner
|
|
|
|
</div>
|
|
|
|
Cliquez sur n'importe quel fichier modifié dans le menu de publication pour l'ouvrir en vue diff face à la version publiée. Le mode visuel affiche un diff visuel et le mode source affiche un diff textuel. Les fichiers qui ne peuvent pas afficher de diff, comme les images ou les fichiers supprimés, figurent dans la liste mais ne sont pas cliquables.
|
|
|
|
Les [pages masquées](/fr/organize/hidden-pages) qui apparaissent dans le diff de la branch peuvent être ouvertes depuis le menu de publication, même si elles ne figurent pas dans la navigation de votre site.
|
|
|
|
<div id="pull-request-titles-and-descriptions">
|
|
|
|
### Titres et descriptions des pull requests
|
|
|
|
</div>
|
|
|
|
Si votre organisation exige des pull requests, vous pouvez saisir un titre et une description au moment de publier. Si vous laissez l'un des deux vide, l'éditeur en génère un listant les fichiers que vous avez créés, mis à jour, déplacés ou supprimés. Pour contrôler leur rédaction, définissez des [instructions de PR](/fr/editor/settings#pr-instructions).
|
|
|
|
Si votre branch comporte des fils de commentaires ouverts, Mintlify ajoute leur résumé à la description de la pull request. Consultez [Collaborer](/fr/editor/collaborate#comments).
|
|
|
|
<div id="review-an-automation-run">
|
|
|
|
## Réviser une exécution d'automatisation
|
|
|
|
</div>
|
|
|
|
Lorsqu'une [automatisation](/fr/automations) ouvre une pull request, vous pouvez ouvrir l'éditeur sur la branch de l'automatisation :
|
|
|
|
- Depuis la page **Automation Runs** de votre dashboard, cliquez sur **Open in editor** sur une exécution terminée.
|
|
- Depuis une notification Slack, cliquez sur le lien **View changes**.
|
|
|
|
Ces deux points d'entrée ouvrent l'éditeur sur la branch de l'automatisation, avec les pages modifiées présélectionnées dans le menu de publication, ce qui vous permet de réviser le diff et de fusionner ou de demander des modifications sans quitter l'éditeur. L'[agent](/fr/editor/agent#continue-an-automation-run) s'ouvre à côté avec le contexte de ce qu'a fait l'automatisation.
|