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
29 changes: 23 additions & 6 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,12 +10,16 @@

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 | ❌ | ✅ | ✅ |
Expand All @@ -34,6 +38,19 @@
Limit admin access to only the people who need to perform admin tasks.
</Tip>

### 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.
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>
Uploading media requires an editor or admin [role](/dashboard/roles). Viewers cannot upload images or videos.
</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 @@ -45,6 +45,10 @@

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.

<Info>
[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).

Check warning on line 49 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L49

In general, use active voice instead of passive voice ('are limited').
</Info>

- **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 <kbd>/</kbd> to open the component menu and select components.
Expand All @@ -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
2 changes: 2 additions & 0 deletions editor/publish.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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.

<Info>
[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.
</Info>

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