Skip to content
Draft
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
4 changes: 4 additions & 0 deletions components/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,10 @@ Mintlify provides built-in MDX components for your documentation pages. Use thes
Display additional information on hover.
</Card>

<Card title="Mention" icon="at-sign" href="/components/mention">
Mention a teammate or another page inline.
</Card>

## Showcase AI prompts

<Card title="Prompt" icon="sparkles" href="/components/prompt">
Expand Down
41 changes: 41 additions & 0 deletions components/mention.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: "Mention"
description: "Mention a teammate or another page inline with the Mention component."
keywords: ["mention", "mentions", "teammate", "page mention", "user"]
boost: 3
tag: "New"
---

Use `<Mention>` to mention a teammate or another page. Provide exactly one of `user` or `page`.

In the [web editor](/editor/pages#mention-teammates-and-pages), type <kbd>@</kbd> in visual mode to insert a mention.

## Mention a teammate

```mdx
<Mention user="wintergreen@example.com" />
```

The `user` value is the teammate's email address. They must belong to your organization.

On the published site, teammate mentions appear as the person's display name, not their email. Mintlify emails the teammate when you insert the mention from the <kbd>@</kbd> menu in the editor. Saving, pasting, or committing the mention does not send email. Mentioning yourself does not send email.

On a private page, the mentioned teammate must already have access.

## Mention a page

```mdx
<Mention page="/quickstart" />
```

The `page` value is the page href. In the editor, the mention shows the current page title. On the published site, page mentions become regular links.

## Properties

<ResponseField name="user" type="string">
Email address of the organization member to mention. Provide `user` or `page`, not both.
</ResponseField>

<ResponseField name="page" type="string">
Path of the page to mention, such as `/quickstart`. Provide `user` or `page`, not both.
</ResponseField>
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@
"components/github",
"components/icons",
"components/mermaid-diagrams",
"components/mention",
"components/panel",
"components/prompt",
"components/responses",
Expand Down
2 changes: 1 addition & 1 deletion editor/agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@

## Open the agent

Click **Ask agent** in the editor toolbar, or press <kbd>Cmd</kbd> + <kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>I</kbd> (Windows).

Check warning on line 13 in editor/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/agent.mdx#L13

Avoid first-person pronouns such as ' I '.

Type <kbd>@</kbd> to mention a specific page, and the agent focuses on it. Without a mention, it uses the page you currently have open.
Type <kbd>@</kbd> to mention a specific page, and the agent focuses on it. Without a mention, it uses the page you currently have open. This mention adds context for the agent only. To insert a mention into your content, see [Mention teammates and pages](/editor/pages#mention-teammates-and-pages).

Example prompts:

Expand All @@ -31,7 +31,7 @@
- **Documents**: PDF
- **Code and text**: `.js`, `.ts`, `.jsx`, `.tsx`, `.mdx`, `.md`, `.json`, `.yaml`, `.html`, `.css`, Python, Go, Rust, Ruby, Java, Swift, C, C++, SQL, shell scripts, and more

Maximum size: 5 MB per file, except SVG files, which are limited to 256 KB. Maximum: 10 files per message.

Check warning on line 34 in editor/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/agent.mdx#L34

In general, use active voice instead of passive voice ('are limited').

Mintlify strips scripts and other active content from SVG files before the agent reads them.

Expand Down
2 changes: 1 addition & 1 deletion editor/collaborate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ All [roles](/dashboard/roles) can comment and reply, including viewers. Only edi

You can delete your own comments and admins can delete any comment. Deleting the first comment in a thread deletes the entire thread.

Type `@` to mention a teammate. They must be a member of your organization and they receive an email notification.
Type <kbd>@</kbd> to mention a teammate. They must be a member of your organization and they receive an email notification. To mention a teammate or a page in the page content instead, see [Mention teammates and pages](/editor/pages#mention-teammates-and-pages).

If your branch has an open pull request, Mintlify adds a summary of unresolved threads to the pull request description, with a link back to each comment. The summary updates as threads change.

Expand Down
1 change: 1 addition & 0 deletions editor/keyboard-shortcuts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ Use these shortcuts when editing in visual mode.
| **Toggle suggesting mode** | <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>E</kbd> | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>E</kbd> |
| **Component menu** | <kbd>/</kbd> | <kbd>/</kbd> |
| **Emoji picker** | <kbd>:</kbd> + keyword | <kbd>:</kbd> + keyword |
| **Mention a teammate or page** | <kbd>@</kbd> | <kbd>@</kbd> |

### Smart substitutions

Expand Down
11 changes: 10 additions & 1 deletion editor/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
title: "Create and edit pages"
sidebarTitle: "Edit content"
description: "Create pages, edit content, add media, organize your navigation, and recover earlier versions of a page in the editor."
keywords: ["editor", "content", "pages", "navigation", "version history", "media", "images", "private pages"]
keywords: ["editor", "content", "pages", "navigation", "version history", "media", "images", "private pages", "mentions"]
---

## Home and Publishing

Check warning on line 8 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L8

'Home and Publishing' should use sentence-style capitalization.

The editor workspace is split into two tabs: **Home** and **Publishing**.

Check warning on line 10 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L10

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

**Home** is your workspace. It shows the content files in your repository, including your private pages, whether or not they appear on your published site.

Check warning on line 12 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L12

Use the Oxford comma in 'It shows the content files in your repository, including your private pages, whether or'.

**Publishing** is your published site. It shows the navigation your visitors see, along with your site settings.

Expand All @@ -30,6 +30,15 @@

For formatting images and using the Frame component, see [Images and embeds](/create/image-embeds).

## Mention teammates and pages

In visual mode, type <kbd>@</kbd> to open the mention menu, then select a teammate or a page. The menu inserts one mention at a time.

- **Teammates** must belong to your organization. Mintlify emails them when you select them from the menu. Saving, pasting, or committing a mention does not send email, and mentioning yourself never does. On a private page, the teammate must already have access. On your published site, the mention renders as the person's display name, not their email.
- **Pages** show the current page title in the editor. On your published site, page mentions render as regular links.

In source mode, use the [Mention](/components/mention) component.

## Organize navigation

Drag elements in the Navigation view to reorder or nest them. The editor writes your changes to `docs.json` when you publish.
Expand Down Expand Up @@ -59,7 +68,7 @@

To view version history, click <Icon icon="ellipsis" /> **More options** in the top-right of the page, then click **Version history**.

If you restore a version, it overwrites any unsaved changes you made to the page. When you restore a public page, it is only restored on your current branch. When you restore a private page, it is restored on all branches.

Check warning on line 71 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L71

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

## Private pages

Expand Down