From 3345d703b5120f0354e1347f1aa72b14813b0d41 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Sat, 3 Oct 2026 21:30:33 +0000 Subject: [PATCH 1/2] docs: document page-level comments in the editor --- editor/collaborate.mdx | 10 +++++++++- es/editor/collaborate.mdx | 10 +++++++++- fr/editor/collaborate.mdx | 10 +++++++++- zh/editor/collaborate.mdx | 10 +++++++++- 4 files changed, 36 insertions(+), 4 deletions(-) diff --git a/editor/collaborate.mdx b/editor/collaborate.mdx index 7f18bad75..34fb25317 100644 --- a/editor/collaborate.mdx +++ b/editor/collaborate.mdx @@ -13,7 +13,7 @@ Work with your team on a page by commenting on it, suggesting changes to it, or All [roles](/dashboard/roles) can comment, reply, and resolve threads. -Comments let you leave feedback on specific text without editing the content. +Comments let you leave feedback on specific text or on a whole page without editing the content. **Comments never reach your repository.** They only appear in the editor. Mintlify never includes them in your published site and never commits them to Git. If your branch has an open pull request, Mintlify adds a summary of unresolved threads to the pull request description, with a link back to each comment. The summary updates as threads change. @@ -24,6 +24,14 @@ To add a comment, highlight text and click the +To comment on the whole page instead of specific text, use any of these options: + +- Hover over the page title and click **Add comment**. +- Click **More options** in the top-right of the page, then click **Comment on page**. +- In the comments panel, click **New comment**. + +Page comments appear beside the page title. + Type `@` to mention a teammate in a comment. They must be a member of your organization who has accepted their invitation. When you mention a teammate in a comment, they receive an email notification. Manage which comment and suggestion emails you receive from the [Notifications](/dashboard/notifications) page of your dashboard. Comment threads appear in both visual and source mode. In source mode, you can read, reply to, and resolve existing threads, but starting a new comment requires visual mode. diff --git a/es/editor/collaborate.mdx b/es/editor/collaborate.mdx index 79d337490..9621d1165 100644 --- a/es/editor/collaborate.mdx +++ b/es/editor/collaborate.mdx @@ -17,7 +17,7 @@ Trabaje con su equipo en una página comentándola, sugiriendo cambios o editán Todos los [roles](/es/dashboard/roles) pueden comentar, responder y resolver hilos. -Los comentarios le permiten dejar opiniones sobre un texto concreto sin editar el contenido. +Los comentarios le permiten dejar opiniones sobre un texto concreto o sobre una página completa sin editar el contenido. **Los comentarios nunca llegan a su repositorio.** Existen solo dentro del editor y nunca se incluyen en el sitio publicado ni se hacen commit en Git. Si su branch tiene una pull request abierta, Mintlify añade a su descripción un resumen de los hilos sin resolver, con un enlace a cada comentario. El resumen se actualiza a medida que cambian los hilos. @@ -28,6 +28,14 @@ Para añadir un comentario, resalte un texto y haga clic en el icono +Para comentar la página completa en lugar de un texto concreto, use cualquiera de estas opciones: + +- Pase el cursor sobre el título de la página y haga clic en **Add comment**. +- Haga clic en **More options** en la esquina superior derecha de la página y luego en **Comment on page**. +- En el panel de comentarios, haga clic en **New comment**. + +Los comentarios de página aparecen junto al título de la página. + Escriba `@` para mencionar a un compañero en un comentario. Debe ser miembro de su organización y haber aceptado su invitación. Cuando menciona a un compañero en un comentario, recibe una notificación por correo electrónico. Gestione qué correos de comentarios y sugerencias recibe desde la página de [Notificaciones](/es/dashboard/notifications) de su dashboard. Los hilos de comentarios aparecen tanto en el modo visual como en el modo source. En el modo source puede leer, responder y resolver hilos existentes, pero para iniciar un comentario nuevo necesita el modo visual. diff --git a/fr/editor/collaborate.mdx b/fr/editor/collaborate.mdx index 807871fac..309fb8042 100644 --- a/fr/editor/collaborate.mdx +++ b/fr/editor/collaborate.mdx @@ -17,7 +17,7 @@ Travaillez avec votre équipe sur une page en la commentant, en y proposant des Tous les [rôles](/fr/dashboard/roles) peuvent commenter, répondre et résoudre les fils. -Les commentaires vous permettent de laisser un retour sur un texte précis sans modifier le contenu. +Les commentaires vous permettent de laisser un retour sur un texte précis ou sur une page entière sans modifier le contenu. **Les commentaires n'atteignent jamais votre dépôt.** Ils n'existent que dans l'éditeur et ne sont jamais inclus dans le site publié ni commités dans Git. Si votre branch comporte une pull request ouverte, Mintlify ajoute à sa description un résumé des fils non résolus, avec un lien vers chaque commentaire. Le résumé se met à jour au fil des changements. @@ -28,6 +28,14 @@ Pour ajouter un commentaire, surlignez du texte et cliquez sur l'icône +Pour commenter la page entière plutôt qu'un texte précis, utilisez l'une de ces options : + +- Survolez le titre de la page et cliquez sur **Add comment**. +- Cliquez sur **More options** en haut à droite de la page, puis sur **Comment on page**. +- Dans le panneau des commentaires, cliquez sur **New comment**. + +Les commentaires de page apparaissent à côté du titre de la page. + Saisissez `@` pour mentionner un collègue dans un commentaire. Il doit être membre de votre organisation et avoir accepté son invitation. Lorsque vous mentionnez un collègue dans un commentaire, il reçoit une notification par e-mail. Gérez les e-mails de commentaires et de suggestions que vous recevez depuis la page [Notifications](/fr/dashboard/notifications) de votre dashboard. Les fils de commentaires apparaissent aussi bien en mode visuel qu'en mode source. En mode source, vous pouvez lire, répondre et résoudre les fils existants, mais démarrer un nouveau commentaire nécessite le mode visuel. diff --git a/zh/editor/collaborate.mdx b/zh/editor/collaborate.mdx index f30cc55f5..3116b2bd4 100644 --- a/zh/editor/collaborate.mdx +++ b/zh/editor/collaborate.mdx @@ -17,7 +17,7 @@ keywords: ["comments", "suggestions", "collaboration", "review", "mentions", "re 所有[角色](/zh/dashboard/roles)都可以评论、回复和解决线程。 -评论让你可以针对特定文本留下反馈，而无需修改内容。 +评论让你可以针对特定文本或整个页面留下反馈，而无需修改内容。 **评论永远不会进入你的仓库。** 它们仅存在于编辑器中，不会包含在已发布的站点里，也不会提交到 Git。如果你的分支有打开的 pull request，Mintlify 会在其描述中添加未解决线程的摘要，并附上指向每条评论的链接。该摘要会随线程的变化而更新。 @@ -28,6 +28,14 @@ keywords: ["comments", "suggestions", "collaboration", "review", "mentions", "re 编辑器中所选文本上方浮动工具栏里的评论按钮。 +若要对整个页面而非特定文本发表评论，可使用以下任一方式： + +- 将鼠标悬停在页面标题上，然后点击 **Add comment**。 +- 点击页面右上角的 **More options**，然后点击 **Comment on page**。 +- 在评论面板中，点击 **New comment**。 + +页面评论显示在页面标题旁边。 + 在评论中输入 `@` 即可提及同事。对方必须是你所在组织的成员，并且已经接受邀请。在评论中提及同事时，对方会收到电子邮件通知。你可以在仪表板的[通知](/zh/dashboard/notifications)页面管理接收哪些评论和建议邮件。 评论线程在可视化模式和 source 模式下都可见。在 source 模式下，你可以阅读、回复和解决已有的线程，但要发起新评论则需要进入可视化模式。 From 37a93e5b02e8aa1adda09d5f02023f45183545fb Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Sat, 3 Oct 2026 22:40:03 +0000 Subject: [PATCH 2/2] docs: remove Comment on page menu option from page comment steps --- editor/collaborate.mdx | 3 +-- es/editor/collaborate.mdx | 3 +-- fr/editor/collaborate.mdx | 3 +-- zh/editor/collaborate.mdx | 3 +-- 4 files changed, 4 insertions(+), 8 deletions(-) diff --git a/editor/collaborate.mdx b/editor/collaborate.mdx index 34fb25317..583c3edbd 100644 --- a/editor/collaborate.mdx +++ b/editor/collaborate.mdx @@ -24,10 +24,9 @@ To add a comment, highlight text and click the -To comment on the whole page instead of specific text, use any of these options: +To comment on the whole page instead of specific text, use either of these options: - Hover over the page title and click **Add comment**. -- Click **More options** in the top-right of the page, then click **Comment on page**. - In the comments panel, click **New comment**. Page comments appear beside the page title. diff --git a/es/editor/collaborate.mdx b/es/editor/collaborate.mdx index 9621d1165..b9209519a 100644 --- a/es/editor/collaborate.mdx +++ b/es/editor/collaborate.mdx @@ -28,10 +28,9 @@ Para añadir un comentario, resalte un texto y haga clic en el icono -Para comentar la página completa en lugar de un texto concreto, use cualquiera de estas opciones: +Para comentar la página completa en lugar de un texto concreto, use cualquiera de estas dos opciones: - Pase el cursor sobre el título de la página y haga clic en **Add comment**. -- Haga clic en **More options** en la esquina superior derecha de la página y luego en **Comment on page**. - En el panel de comentarios, haga clic en **New comment**. Los comentarios de página aparecen junto al título de la página. diff --git a/fr/editor/collaborate.mdx b/fr/editor/collaborate.mdx index 309fb8042..7373e9c5e 100644 --- a/fr/editor/collaborate.mdx +++ b/fr/editor/collaborate.mdx @@ -28,10 +28,9 @@ Pour ajouter un commentaire, surlignez du texte et cliquez sur l'icône -Pour commenter la page entière plutôt qu'un texte précis, utilisez l'une de ces options : +Pour commenter la page entière plutôt qu'un texte précis, utilisez l'une de ces deux options : - Survolez le titre de la page et cliquez sur **Add comment**. -- Cliquez sur **More options** en haut à droite de la page, puis sur **Comment on page**. - Dans le panneau des commentaires, cliquez sur **New comment**. Les commentaires de page apparaissent à côté du titre de la page. diff --git a/zh/editor/collaborate.mdx b/zh/editor/collaborate.mdx index 3116b2bd4..355dd45cc 100644 --- a/zh/editor/collaborate.mdx +++ b/zh/editor/collaborate.mdx @@ -28,10 +28,9 @@ keywords: ["comments", "suggestions", "collaboration", "review", "mentions", "re 编辑器中所选文本上方浮动工具栏里的评论按钮。 -若要对整个页面而非特定文本发表评论，可使用以下任一方式： +若要对整个页面而非特定文本发表评论，可使用以下两种方式之一： - 将鼠标悬停在页面标题上，然后点击 **Add comment**。 -- 点击页面右上角的 **More options**，然后点击 **Comment on page**。 - 在评论面板中，点击 **New comment**。 页面评论显示在页面标题旁边。