From 7cc1569c049c74f0d731ab094beac0f49583a419 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 17 Mar 2026 21:26:38 +0000 Subject: [PATCH] Clarify viewer role behavior in the web editor Generated-By: mintlify-agent --- dashboard/roles.mdx | 29 +++++++++++++++++++++++------ editor/media.mdx | 4 ++++ editor/pages.mdx | 4 ++++ editor/publish.mdx | 2 ++ editor/suggestions.mdx | 4 ++++ 5 files changed, 37 insertions(+), 6 deletions(-) diff --git a/dashboard/roles.mdx b/dashboard/roles.mdx index e8850e7f2..ad66c0ffb 100644 --- a/dashboard/roles.mdx +++ b/dashboard/roles.mdx @@ -10,12 +10,16 @@ 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 | ❌ | ✅ | ✅ | +| | Viewer | Editor | Admin | +| ------------------------------------- | :----: | :----: | :---: | +| View content in the editor | ✅ | ✅ | ✅ | +| View dashboard and analytics | ✅ | ✅ | ✅ | +| Make suggestions in the editor | ✅ | ✅ | ✅ | +| Leave comments in the editor | ✅ | ✅ | ✅ | +| Edit content in the web editor | ❌ | ✅ | ✅ | +| Upload media in the web editor | ❌ | ✅ | ✅ | +| Publish changes | ❌ | ✅ | ✅ | +| Trigger deployments | ❌ | ✅ | ✅ | | Create and delete API keys | ❌ | ✅ | ✅ | | Configure integrations | ❌ | ✅ | ✅ | | Configure assistant | ❌ | ✅ | ✅ | @@ -34,6 +38,19 @@ Mintlify provides three dashboard access levels: viewer, editor, and admin. Limit admin access to only the people who need to perform admin tasks. +### Viewer experience in the editor + +Viewers can open any page in the [web editor](/editor) and are automatically placed in [suggesting mode](/editor/suggestions). In suggesting mode, viewers can propose text changes for editors and admins to review. + +Viewers cannot: +- Exit suggesting mode or switch to direct editing +- Use formatting tools in the floating toolbar (bold, italic, links, etc.) +- Upload images or videos +- Edit in Markdown mode or the diff editor +- Publish changes or create pull requests + +Viewers can still leave [comments](/editor/comments) on selected text and reply to existing threads. + ## 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..08f790e67 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) + + Uploading media requires an editor or admin [role](/dashboard/roles). Viewers cannot upload images or videos. + + ## Add media to a page ### Drag and drop diff --git a/editor/pages.mdx b/editor/pages.mdx index 3e6549c93..fca1bb13b 100644 --- a/editor/pages.mdx +++ b/editor/pages.mdx @@ -45,6 +45,10 @@ Switch between visual and Markdown mode with the toggle in the toolbar. The web Edit content with real-time previews that show how the content looks when published. The editor uses your browser's built-in spellcheck to highlight misspelled words as you type. + + [Viewers](/dashboard/roles) can view pages in visual mode but cannot use formatting tools. Viewers are limited to [suggesting](/editor/suggestions) text changes and leaving [comments](/editor/comments). + + - **Add text**: Type in the editor to see how the text appears when published. - **Format text**: Use the toolbar to bold, italicize, or apply other formatting to text. - **Add components**: Press / to open the component menu and select components. diff --git a/editor/publish.mdx b/editor/publish.mdx index 6a997f271..d42aeac16 100644 --- a/editor/publish.mdx +++ b/editor/publish.mdx @@ -7,6 +7,8 @@ keywords: ["editor", "publish", "changes", "branches", "pull requests"] ## Publishing workflows +Publishing is available to editors and admins. [Viewers](/dashboard/roles) cannot publish changes or create pull requests. + The editor supports two workflows for publishing documentation updates. The workflow you use depends on your repository's branch protection rules and the branch you work on. * **Create pull requests**: If your repository has a branch protection rule that requires pull requests before changes can merge into your deployment branch, the editor creates a pull request when you publish changes. diff --git a/editor/suggestions.mdx b/editor/suggestions.mdx index 705f37b33..d189351cc 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 exit it. This lets viewers propose changes for editors and admins to review. + +