From d658348c57036c607dba41eb2177604a226f4ca5 Mon Sep 17 00:00:00 2001 From: "mintlify-development[bot]" <109878554+mintlify-development[bot]@users.noreply.github.com> Date: Tue, 17 Mar 2026 21:32:57 +0000 Subject: [PATCH] Clarify viewer role behavior in the web editor Generated-By: mintlify-agent --- dashboard/roles.mdx | 51 ++++++++++++++++++++++++++---------------- editor/media.mdx | 4 ++++ editor/pages.mdx | 4 ++++ editor/publish.mdx | 4 ++++ editor/suggestions.mdx | 4 ++++ 5 files changed, 48 insertions(+), 19 deletions(-) diff --git a/dashboard/roles.mdx b/dashboard/roles.mdx index e8850e7f2..ad4ad84ea 100644 --- a/dashboard/roles.mdx +++ b/dashboard/roles.mdx @@ -10,30 +10,43 @@ keywords: ["RBAC", "role-based access control", "admin", "editor", "viewer", "pe Mintlify provides three dashboard access levels: viewer, editor, and admin. -| | Viewer | Editor | Admin | -| ------------------------------ | :----: | :----: | :---: | -| View content in the editor | ✅ | ✅ | ✅ | -| View dashboard and analytics | ✅ | ✅ | ✅ | -| Edit content in the web editor | ❌ | ✅ | ✅ | -| Trigger deployments | ❌ | ✅ | ✅ | -| Create and delete API keys | ❌ | ✅ | ✅ | -| Configure integrations | ❌ | ✅ | ✅ | -| Configure assistant | ❌ | ✅ | ✅ | -| Configure add-ons | ❌ | ✅ | ✅ | -| Invite editors and viewers | ❌ | ✅ | ✅ | -| Update user roles | ❌ | ❌ | ✅ | -| Invite admins | ❌ | ❌ | ✅ | -| Delete users | ❌ | ❌ | ✅ | -| Manage billing | ❌ | ❌ | ✅ | -| Manage SSO | ❌ | ❌ | ✅ | -| Update custom domain | ❌ | ❌ | ✅ | -| Update Git source | ❌ | ❌ | ✅ | -| Delete organization | ❌ | ❌ | ✅ | +| | Viewer | Editor | Admin | +| -------------------------------------------- | :----: | :----: | :---: | +| View content in the editor | ✅ | ✅ | ✅ | +| View dashboard and analytics | ✅ | ✅ | ✅ | +| Make [suggestions](/editor/suggestions) and [comments](/editor/comments) in the editor | ✅ | ✅ | ✅ | +| Edit and format content in the web editor | ❌ | ✅ | ✅ | +| Upload media | ❌ | ✅ | ✅ | +| Publish changes | ❌ | ✅ | ✅ | +| Trigger deployments | ❌ | ✅ | ✅ | +| Create and delete API keys | ❌ | ✅ | ✅ | +| Configure integrations | ❌ | ✅ | ✅ | +| Configure assistant | ❌ | ✅ | ✅ | +| Configure add-ons | ❌ | ✅ | ✅ | +| Invite editors and viewers | ❌ | ✅ | ✅ | +| Update user roles | ❌ | ❌ | ✅ | +| Invite admins | ❌ | ❌ | ✅ | +| Delete users | ❌ | ❌ | ✅ | +| Manage billing | ❌ | ❌ | ✅ | +| Manage SSO | ❌ | ❌ | ✅ | +| Update custom domain | ❌ | ❌ | ✅ | +| Update Git source | ❌ | ❌ | ✅ | +| Delete organization | ❌ | ❌ | ✅ | Limit admin access to only the people who need to perform admin tasks. +## Viewer role in the editor + +Viewers can open the web editor and browse all pages but cannot directly edit content. When a viewer opens the editor, the following restrictions apply: + +- **Suggesting mode is always active.** Viewers are automatically placed in [suggesting mode](/editor/suggestions) and cannot switch to editing mode. Text changes appear as suggestions for editors or admins to accept or reject. +- **Formatting toolbar is hidden.** The text formatting options (bold, italic, underline, strikethrough, code, and links) are not available. Only the **Comment** button appears in the floating toolbar. +- **Publish button is hidden.** Viewers cannot publish changes or create pull requests. +- **Media uploads are disabled.** Viewers cannot upload images or videos through drag-and-drop or the slash command menu. +- **Markdown mode is read-only.** Viewers can view the source MDX but cannot edit it directly. + ## Add members to your organization By default, the person who creates your Mintlify organization has admin access. Add additional editors in the [Members](https://dashboard.mintlify.com/settings/organization/members) page of your dashboard. diff --git a/editor/media.mdx b/editor/media.mdx index b98ceb8a3..e9d4126c9 100644 --- a/editor/media.mdx +++ b/editor/media.mdx @@ -11,6 +11,10 @@ keywords: ["editor","media","images","assets"] - **Fonts**: TrueType (TTF), WOFF, WOFF2 - **Other**: PDF, ICO (favicons) + + Media uploads are not available to [viewers](/dashboard/roles). Only editors and admins can upload images, videos, and other assets. + + ## Add media to a page ### Drag and drop diff --git a/editor/pages.mdx b/editor/pages.mdx index 3e6549c93..7d3cb52ac 100644 --- a/editor/pages.mdx +++ b/editor/pages.mdx @@ -27,6 +27,10 @@ Browse your documentation pages in the **Navigation** tab of the left panel. Switch between visual and Markdown mode with the toggle in the toolbar. The web editor saves your changes when switching modes. + + [Viewers](/dashboard/roles) can browse pages and make [suggestions](/editor/suggestions), but cannot directly edit content or use formatting tools. Markdown mode is read-only for viewers. + + + The **Publish** button is not available to [viewers](/dashboard/roles). Viewers can make [suggestions](/editor/suggestions) and [comments](/editor/comments) but cannot publish changes. An editor or admin must review and publish viewer contributions. + + Your live documentation site updates after Mintlify builds and deploys your published changes. This typically takes 30 seconds to a few minutes. Check the deployment status of your changes on your [dashboard](https://dashboard.mintlify.com). diff --git a/editor/suggestions.mdx b/editor/suggestions.mdx index 705f37b33..fb483bc4e 100644 --- a/editor/suggestions.mdx +++ b/editor/suggestions.mdx @@ -19,6 +19,10 @@ While suggesting mode is active, the **Suggesting** indicator appears in the edi To exit suggesting mode, click the **Suggesting** indicator. + + [Viewers](/dashboard/roles) are automatically placed in suggesting mode when they open the editor and cannot switch to editing mode. The **Suggesting** indicator remains visible but cannot be dismissed. See [Viewer role in the editor](/dashboard/roles#viewer-role-in-the-editor) for details. + +