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
51 changes: 32 additions & 19 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 @@ -10,30 +10,43 @@

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 | ❌ | ❌ | ✅ |

<Tip>
Limit admin access to only the people who need to perform admin tasks.
</Tip>

## 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.

Check warning on line 45 in dashboard/roles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/roles.mdx#L45

In general, use active voice instead of passive voice ('is hidden').

Check warning on line 45 in dashboard/roles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/roles.mdx#L45

Use 'Strikethrough' instead of 'strikethrough'.
- **Publish button is hidden.** Viewers cannot publish changes or create pull requests.

Check warning on line 46 in dashboard/roles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/roles.mdx#L46

In general, use active voice instead of passive voice ('is hidden').
- **Media uploads are disabled.** Viewers cannot upload images or videos through drag-and-drop or the slash command menu.

Check warning on line 47 in dashboard/roles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/roles.mdx#L47

In general, use active voice instead of passive voice ('are disabled').
- **Markdown mode is read-only.** Viewers can view the source MDX but cannot edit it directly.

Check warning on line 48 in dashboard/roles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/roles.mdx#L48

In general, use active voice instead of passive voice ('is read').

## 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/media.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
- **Fonts**: TrueType (TTF), WOFF, WOFF2
- **Other**: PDF, ICO (favicons)

<Note>
Media uploads are not available to [viewers](/dashboard/roles). Only editors and admins can upload images, videos, and other assets.
</Note>

## Add media to a page

### Drag and drop
Expand Down Expand Up @@ -62,7 +66,7 @@

### Rename and edit assets

Hover over an asset and click the **...** button to rename the file or update its alt text.

Check warning on line 69 in editor/media.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/media.mdx#L69

In general, don't use an ellipsis.

### Delete assets

Expand Down
4 changes: 4 additions & 0 deletions editor/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@

Switch between visual and Markdown mode with the toggle in the toolbar. The web editor saves your changes when switching modes.

<Note>
[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.

Check warning on line 31 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L31

In general, use active voice instead of passive voice ('is read').
</Note>

<Frame>
<img
src="/images/editor/mode-toggle-light.png"
Expand Down Expand Up @@ -56,7 +60,7 @@
- **Add math equations**: Type <kbd>/inline-math</kbd> for an inline LaTeX equation or <kbd>/block-math</kbd> for a centered block equation. [Enable LaTeX](/editor/configurations) in your site settings first.
- **Add prompt blocks**: Type <kbd>/prompt</kbd> to insert an AI prompt template with copy actions.
- **Edit tables**: When your cursor is inside a table, use the floating toolbar to add or remove rows and columns, or merge cells.
- **Insert links**: Select text and press <kbd>Cmd</kbd> + <kbd>K</kbd>, or drag a page from the navigation tree into the editor to create a link with the page title.

Check warning on line 63 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L63

Did you really mean 'Cmd'?

See [Components](/components) for the complete list of available components.

Expand Down
4 changes: 4 additions & 0 deletions editor/publish.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,10 @@ Click **Publish** in the toolbar. Depending on your workflow, your changes deplo

If there are no pending changes or a pull request for the current branch is already open, the **Publish** button is unclickable.

<Note>
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.
</Note>

<Note>
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).
</Note>
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 @@

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

<Note>
[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.

Check warning on line 23 in editor/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/suggestions.mdx#L23

In general, use active voice instead of passive voice ('be dismissed').
</Note>

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