Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions dashboard/permissions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@ keywords: ["editor access", "permissions", "team", "seats", "deployment"]

People with the editor or admin [role](/dashboard/roles) can use the web editor, trigger deployments, and manage integrations from your dashboard. When an editor or admin publishes through the web editor or merges a pull request into your documentation repository, the changes deploy to your live site automatically.

People with the viewer role can open pages in the web editor and propose changes using [suggesting mode](/editor/suggestions). Viewers cannot directly edit content, upload media, or publish changes.

Anyone with access to your documentation repository can contribute to your documentation by pushing changes to the repository, but their changes do not deploy until an editor or admin manually triggers a deployment from your dashboard.
14 changes: 14 additions & 0 deletions dashboard/roles.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Roles"
description: "Assign admin, editor, or viewer roles to manage team access and permissions."
keywords: ["RBAC", "role-based access control", "admin", "editor", "viewer", "permissions"]

Check warning on line 4 in dashboard/roles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/roles.mdx#L4

Spell out 'RBAC', if it's unfamiliar to the audience.
---

<Info>
Expand All @@ -14,7 +14,9 @@
| ------------------------------ | :----: | :----: | :---: |
| View content in the editor | ✅ | ✅ | ✅ |
| View dashboard and analytics | ✅ | ✅ | ✅ |
| Make suggestions in the editor | ✅ | ✅ | ✅ |
| Edit content in the web editor | ❌ | ✅ | ✅ |
| Upload media | ❌ | ✅ | ✅ |
| Trigger deployments | ❌ | ✅ | ✅ |
| Create and delete API keys | ❌ | ✅ | ✅ |
| Configure integrations | ❌ | ✅ | ✅ |
Expand All @@ -34,6 +36,18 @@
Limit admin access to only the people who need to perform admin tasks.
</Tip>

## Viewer access in the web editor

Viewers can open pages in the web editor and propose changes using [suggesting mode](/editor/suggestions). The editor automatically enables suggesting mode for viewers and prevents them from switching to direct editing.

Viewers cannot:
- Use text formatting tools (bold, italic, underline, strikethrough, code, links)

Check warning on line 44 in dashboard/roles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/roles.mdx#L44

Use 'Strikethrough' instead of 'strikethrough'.
- Change content types (headings, lists, etc.)
- Upload images or videos
- Publish changes

This makes the viewer role ideal for stakeholders, reviewers, or subject-matter experts who need to propose content changes without direct write access.

## 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.
Expand Down
4 changes: 4 additions & 0 deletions editor/suggestions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ While suggesting mode is active, the **Suggesting** indicator appears in the edi

To exit suggesting mode, click the **Suggesting** indicator.

<Note>
Users with the [viewer role](/dashboard/roles) are always in suggesting mode. The editor enables suggesting mode automatically for viewers and does not allow them to switch to direct editing.
</Note>

<Frame>
<img
src="/images/editor/suggesting-light.png"
Expand Down
Loading