From cf93815d93136d12ab3129c4ecf7c247956acecc Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 19 May 2026 00:26:02 +0000 Subject: [PATCH 1/2] docs: document editing docs.json directly in the web editor --- editor/branching-and-publishing.mdx | 4 ++++ editor/configurations.mdx | 19 +++++++++++++++++++ editor/keyboard-shortcuts.mdx | 8 ++++++++ editor/navigation.mdx | 2 +- 4 files changed, 32 insertions(+), 1 deletion(-) diff --git a/editor/branching-and-publishing.mdx b/editor/branching-and-publishing.mdx index a58966e5ac..918d87b8a6 100644 --- a/editor/branching-and-publishing.mdx +++ b/editor/branching-and-publishing.mdx @@ -140,6 +140,10 @@ Click any changed file in the publish menu to open it in diff view and compare y Only one publish can happen at a time per branch. If another team member publishes to the same branch, wait for the current publish to complete before trying again. +### Unapplied `docs.json` changes + +If `docs.json` has edits that haven't been applied, the publish menu shows a **docs.json has unapplied changes** banner and disables the publish actions. Click the banner to open `docs.json`, then apply or discard the edits to unblock publishing. See [Edit docs.json directly](/editor/configurations#edit-docs-json-directly). + ### Commit messages When you publish, you can enter a commit message before confirming. If you leave it blank, the editor generates a message based on the files changed. diff --git a/editor/configurations.mdx b/editor/configurations.mdx index 3e9ec1145d..8d5e7266fc 100644 --- a/editor/configurations.mdx +++ b/editor/configurations.mdx @@ -139,3 +139,22 @@ To edit or remove an existing redirect: - **Menu drilldown**: Enable or disable auto-navigating to the first page when a user clicks a navigation group. - **Timestamps**: Show "Last modified on [date]" on all pages. - **SEO indexing**: Choose whether to index hidden pages for search engines. + +## Edit `docs.json` directly + +For configuration options that aren't surfaced in the **Configurations** panel, open `docs.json` from the file tree and edit it as raw JSON. Manual edits and changes from the **Configurations** panel stay in sync, so you can switch between them on the same branch. + +When you open `docs.json`, a toolbar appears above the editor with **Apply changes** and **Discard** actions: + +- **Apply changes**: Validates your JSON and writes it to the working copy of `docs.json` on the current branch. The navigation sidebar updates immediately to reflect the new structure. Press Cmd + S (macOS) or Ctrl + S (Windows) to apply. +- **Discard**: Reverts the file back to the last applied version. + +If your edit contains invalid JSON, the toolbar turns red and shows the line number of the syntax error. **Apply changes** stays disabled until the JSON parses successfully. + + + Applying changes does not publish them. To deploy your edits to your live site, use **Publish** in the toolbar. See [Branching and publishing](/editor/branching-and-publishing). + + + + The publish menu blocks publishing while `docs.json` has unapplied edits and shows a **docs.json has unapplied changes** banner. Click the banner to open the file, then apply or discard your changes before publishing. + diff --git a/editor/keyboard-shortcuts.mdx b/editor/keyboard-shortcuts.mdx index 9014630ab0..a89b87bfaa 100644 --- a/editor/keyboard-shortcuts.mdx +++ b/editor/keyboard-shortcuts.mdx @@ -96,3 +96,11 @@ Markdown mode uses the Monaco editor, which supports standard VS Code keyboard s | **Add cursor** | Option + Click | Alt + Click | | **Add cursor above** | Cmd + Option + ↑ | Ctrl + Alt + ↑ | | **Add cursor below** | Cmd + Option + ↓ | Ctrl + Alt + ↓ | + +## `docs.json` editor + +Use these shortcuts when editing `docs.json` directly. See [Edit docs.json directly](/editor/configurations#edit-docs-json-directly). + +| Command | macOS | Windows | +| :--- | :--- | :--- | +| **Apply changes** | Cmd + S | Ctrl + S | diff --git a/editor/navigation.mdx b/editor/navigation.mdx index 2c1894be98..eb4abc774e 100644 --- a/editor/navigation.mdx +++ b/editor/navigation.mdx @@ -4,7 +4,7 @@ description: "Reorder pages, add groups, and manage your documentation sidebar s keywords: ["editor", "navigation", "sidebar", "structure"] --- -Use the navigation sidebar to organize your documentation. Changes you make in the editor sync to your repository when you publish—you don't need to edit `docs.json` manually. +Use the navigation sidebar to organize your documentation. Changes you make in the editor sync to your repository when you publish—you don't need to edit `docs.json` manually. If you prefer to edit the file directly, see [Edit docs.json directly](/editor/configurations#edit-docs-json-directly). ## Add navigation elements From 91af3d480e0ebbf891e7e9eeb12a2d6d083dc181 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 19 May 2026 00:36:57 +0000 Subject: [PATCH 2/2] docs: mirror docs.json editor docs into fr and es --- editor/configurations.mdx | 2 +- es/editor/configurations.mdx | 22 +++++++++++++++++++++- es/editor/keyboard-shortcuts.mdx | 11 ++++++++++- es/editor/navigation.mdx | 2 +- es/editor/publish.mdx | 6 ++++++ fr/editor/configurations.mdx | 23 ++++++++++++++++++++++- fr/editor/keyboard-shortcuts.mdx | 11 ++++++++++- fr/editor/navigation.mdx | 2 +- fr/editor/publish.mdx | 6 ++++++ 9 files changed, 78 insertions(+), 7 deletions(-) diff --git a/editor/configurations.mdx b/editor/configurations.mdx index 8d5e7266fc..dd52a659df 100644 --- a/editor/configurations.mdx +++ b/editor/configurations.mdx @@ -147,7 +147,7 @@ For configuration options that aren't surfaced in the **Configurations** panel, When you open `docs.json`, a toolbar appears above the editor with **Apply changes** and **Discard** actions: - **Apply changes**: Validates your JSON and writes it to the working copy of `docs.json` on the current branch. The navigation sidebar updates immediately to reflect the new structure. Press Cmd + S (macOS) or Ctrl + S (Windows) to apply. -- **Discard**: Reverts the file back to the last applied version. +- **Discard**: Reverts the file to the last applied version. If your edit contains invalid JSON, the toolbar turns red and shows the line number of the syntax error. **Apply changes** stays disabled until the JSON parses successfully. diff --git a/es/editor/configurations.mdx b/es/editor/configurations.mdx index 1fd9394ec9..9df91a5ecb 100644 --- a/es/editor/configurations.mdx +++ b/es/editor/configurations.mdx @@ -123,4 +123,24 @@ Realiza el seguimiento del comportamiento de los visitantes con: Integraciones adicionales: * **Telemetry**: Activa o desactiva la telemetría de uso -* **Cookies**: Define pares personalizados de key y value de cookies \ No newline at end of file +* **Cookies**: Define pares personalizados de key y value de cookies +
+ ## Editar `docs.json` directamente +
+ +Para las opciones de configuración que no aparecen en el panel **Configurations**, abre `docs.json` desde el árbol de archivos y edítalo como JSON sin formato. Las ediciones manuales y los cambios realizados desde el panel **Configurations** se mantienen sincronizados, por lo que puedes alternar entre ambos en la misma branch. + +Cuando abres `docs.json`, aparece una barra de herramientas encima del editor con las acciones **Apply changes** y **Discard**: + +- **Apply changes**: Valida tu JSON y lo escribe en la copia de trabajo de `docs.json` en la branch actual. La barra lateral de navegación se actualiza de inmediato para reflejar la nueva estructura. Presiona Cmd + S (macOS) o Ctrl + S (Windows) para aplicar. +- **Discard**: Revierte el archivo a la última versión aplicada. + +Si tu edición contiene JSON no válido, la barra de herramientas se vuelve roja y muestra el número de línea del error de sintaxis. **Apply changes** permanece deshabilitado hasta que el JSON se analice correctamente. + + + Aplicar los cambios no los publica. Para implementar tus ediciones en tu sitio en producción, usa **Publish** en la barra de herramientas. Consulta [Publicar](/es/editor/publish). + + + + El menú de publicación bloquea la publicación mientras `docs.json` tenga ediciones sin aplicar y muestra un banner **docs.json has unapplied changes**. Haz clic en el banner para abrir el archivo, luego aplica o descarta tus cambios antes de publicar. + diff --git a/es/editor/keyboard-shortcuts.mdx b/es/editor/keyboard-shortcuts.mdx index 81dcba943d..af5828b131 100644 --- a/es/editor/keyboard-shortcuts.mdx +++ b/es/editor/keyboard-shortcuts.mdx @@ -117,4 +117,13 @@ El modo Markdown usa el editor Monaco, que es compatible con los atajos de tecla | :--- | :--- | :--- | | **Agregar cursor** | Option + clic | Alt + clic | | **Agregar cursor encima** | Cmd + Option + ↑ | Ctrl + Alt + ↑ | -| **Agregar cursor debajo** | Cmd + Option + ↓ | Ctrl + Alt + ↓ | \ No newline at end of file +| **Agregar cursor debajo** | Cmd + Option + ↓ | Ctrl + Alt + ↓ | +
+ ## Editor de `docs.json` +
+ +Usa estos atajos al editar `docs.json` directamente. Consulta [Editar docs.json directamente](/es/editor/configurations#edit-docs-json-directly). + +| Comando | macOS | Windows | +| :--- | :--- | :--- | +| **Aplicar cambios** | Cmd + S | Ctrl + S | diff --git a/es/editor/navigation.mdx b/es/editor/navigation.mdx index a00d0e609f..3ea44b21cb 100644 --- a/es/editor/navigation.mdx +++ b/es/editor/navigation.mdx @@ -4,7 +4,7 @@ description: "Organiza la estructura de tu sitio de documentación con el editor keywords: ["editor", "navegación", "barra lateral", "estructura"] --- -Usa la barra lateral de navegación para organizar tu documentación. Los cambios que realices en el árbol de navegación del editor web aparecerán en la barra lateral de navegación de tu sitio y se sincronizarán con tu archivo de configuración `docs.json`. +Usa la barra lateral de navegación para organizar tu documentación. Los cambios que realices en el árbol de navegación del editor web aparecerán en la barra lateral de navegación de tu sitio y se sincronizarán con tu archivo de configuración `docs.json`. Si prefieres editar el archivo directamente, consulta [Editar docs.json directamente](/es/editor/configurations#edit-docs-json-directly).
## Agregar elementos de navegación diff --git a/es/editor/publish.mdx b/es/editor/publish.mdx index b53afe9b9b..22989c4101 100644 --- a/es/editor/publish.mdx +++ b/es/editor/publish.mdx @@ -93,6 +93,12 @@ Los conflictos se producen cuando intentas fusionar branches con cambios incompa * Tú y otra persona del equipo modifican las mismas líneas de un archivo en distintas branches. * Los archivos se mueven, renombran o eliminan en una branch, pero se modifican de otra forma en otra. +
+ ### Cambios sin aplicar en `docs.json` +
+ +Si `docs.json` tiene ediciones que no se han aplicado, el menú de publicación muestra un banner **docs.json has unapplied changes** y deshabilita las acciones de publicación. Haz clic en el banner para abrir `docs.json` y luego aplica o descarta las ediciones para desbloquear la publicación. Consulta [Editar docs.json directamente](/es/editor/configurations#edit-docs-json-directly). +
### Resolver conflictos
diff --git a/fr/editor/configurations.mdx b/fr/editor/configurations.mdx index 9ec1f6cd02..6a6f8087a2 100644 --- a/fr/editor/configurations.mdx +++ b/fr/editor/configurations.mdx @@ -123,4 +123,25 @@ Suivez le comportement des visiteurs avec : Intégrations supplémentaires : * **Telemetry** : activer ou désactiver la télémétrie d'utilisation -* **Cookies** : définir des paires clé/valeur de cookies personnalisées \ No newline at end of file +* **Cookies** : définir des paires clé/valeur de cookies personnalisées + +
+ ## Modifier `docs.json` directement +
+ +Pour les options de configuration qui n'apparaissent pas dans le panneau **Configurations**, ouvrez `docs.json` depuis l'arborescence de fichiers et modifiez-le sous forme de JSON brut. Les modifications manuelles et les changements effectués depuis le panneau **Configurations** restent synchronisés, vous pouvez donc passer de l'un à l'autre sur la même branche. + +Lorsque vous ouvrez `docs.json`, une barre d'outils apparaît au-dessus de l'éditeur avec les actions **Apply changes** et **Discard** : + +- **Apply changes** : Valide votre JSON et l'écrit dans la copie de travail de `docs.json` sur la branche actuelle. La barre latérale de navigation se met à jour immédiatement pour refléter la nouvelle structure. Appuyez sur Cmd + S (macOS) ou Ctrl + S (Windows) pour appliquer. +- **Discard** : Restaure le fichier à la dernière version appliquée. + +Si votre modification contient un JSON invalide, la barre d'outils devient rouge et affiche le numéro de ligne de l'erreur de syntaxe. **Apply changes** reste désactivé jusqu'à ce que le JSON soit analysé correctement. + + + Appliquer les modifications ne les publie pas. Pour déployer vos modifications sur votre site en production, utilisez **Publish** dans la barre d'outils. Consultez [Publier](/fr/editor/publish). + + + + Le menu de publication bloque la publication tant que `docs.json` contient des modifications non appliquées et affiche une bannière **docs.json has unapplied changes**. Cliquez sur la bannière pour ouvrir le fichier, puis appliquez ou ignorez vos modifications avant de publier. + \ No newline at end of file diff --git a/fr/editor/keyboard-shortcuts.mdx b/fr/editor/keyboard-shortcuts.mdx index d17bb7e473..d912388c26 100644 --- a/fr/editor/keyboard-shortcuts.mdx +++ b/fr/editor/keyboard-shortcuts.mdx @@ -117,4 +117,13 @@ Le mode Markdown utilise l’éditeur Monaco, qui prend en charge les raccourcis | :--- | :--- | :--- | | **Ajouter un curseur** | Option + Clic | Alt + Clic | | **Ajouter un curseur au-dessus** | Cmd + Option + ↑ | Ctrl + Alt + ↑ | -| **Ajouter un curseur en dessous** | Cmd + Option + ↓ | Ctrl + Alt + ↓ | \ No newline at end of file +| **Ajouter un curseur en dessous** | Cmd + Option + ↓ | Ctrl + Alt + ↓ | +
+ ## Éditeur `docs.json` +
+ +Utilisez ces raccourcis lors de la modification directe de `docs.json`. Consultez [Modifier docs.json directement](/fr/editor/configurations#edit-docs-json-directly). + +| Commande | macOS | Windows | +| :--- | :--- | :--- | +| **Appliquer les modifications** | Cmd + S | Ctrl + S | diff --git a/fr/editor/navigation.mdx b/fr/editor/navigation.mdx index 7d158926be..34d3ccc3b2 100644 --- a/fr/editor/navigation.mdx +++ b/fr/editor/navigation.mdx @@ -4,7 +4,7 @@ description: "Organisez la structure de votre site de documentation avec l’éd keywords: ["editor", "navigation", "sidebar", "structure"] --- -Utilisez la barre latérale de navigation pour organiser votre documentation. Les modifications que vous effectuez dans l’arborescence de navigation de l’éditeur web apparaissent dans la barre latérale de navigation de votre site et sont synchronisées avec votre fichier de configuration `docs.json`. +Utilisez la barre latérale de navigation pour organiser votre documentation. Les modifications que vous effectuez dans l’arborescence de navigation de l’éditeur web apparaissent dans la barre latérale de navigation de votre site et sont synchronisées avec votre fichier de configuration `docs.json`. Si vous préférez modifier le fichier directement, consultez [Modifier docs.json directement](/fr/editor/configurations#edit-docs-json-directly).
## Ajouter des éléments de navigation diff --git a/fr/editor/publish.mdx b/fr/editor/publish.mdx index a5d3083272..2d0fbf6b48 100644 --- a/fr/editor/publish.mdx +++ b/fr/editor/publish.mdx @@ -93,6 +93,12 @@ Les conflits surviennent lorsque vous essayez de fusionner des branches contenan * Vous et un autre membre de l'équipe modifiez les mêmes lignes dans un fichier sur des branches différentes. * Vous déplacez, renommez ou supprimez des fichiers dans une branche, mais les modifiez différemment dans une autre. +
+ ### Modifications non appliquées de `docs.json` +
+ +Si `docs.json` contient des modifications qui n'ont pas été appliquées, le menu de publication affiche une bannière **docs.json has unapplied changes** et désactive les actions de publication. Cliquez sur la bannière pour ouvrir `docs.json`, puis appliquez ou ignorez les modifications pour débloquer la publication. Consultez [Modifier docs.json directement](/fr/editor/configurations#edit-docs-json-directly). +
### Résoudre les conflits