diff --git a/components/index.mdx b/components/index.mdx index 559877e63..2362bbdbb 100644 --- a/components/index.mdx +++ b/components/index.mdx @@ -60,6 +60,10 @@ Mintlify provides built-in MDX components for your documentation pages. Use thes Display additional information on hover. + + Mention a teammate or another page inline. + + ## Showcase AI prompts diff --git a/components/mention.mdx b/components/mention.mdx new file mode 100644 index 000000000..7daf15307 --- /dev/null +++ b/components/mention.mdx @@ -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 `` 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 @ in visual mode to insert a mention. + +## Mention a teammate + +```mdx + +``` + +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 @ 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 + +``` + +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 + + + Email address of the organization member to mention. Provide `user` or `page`, not both. + + + + Path of the page to mention, such as `/quickstart`. Provide `user` or `page`, not both. + diff --git a/docs.json b/docs.json index 43fedbdc4..6807d9b2d 100644 --- a/docs.json +++ b/docs.json @@ -94,6 +94,7 @@ "components/github", "components/icons", "components/mermaid-diagrams", + "components/mention", "components/panel", "components/prompt", "components/responses", diff --git a/editor/agent.mdx b/editor/agent.mdx index a6d63b71e..e4b18902e 100644 --- a/editor/agent.mdx +++ b/editor/agent.mdx @@ -12,7 +12,7 @@ The editor agent makes changes directly in your current branch. Click **Ask agent** in the editor toolbar, or press Cmd + I (macOS) or Ctrl + I (Windows). -Type @ to mention a specific page, and the agent focuses on it. Without a mention, it uses the page you currently have open. +Type @ 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: diff --git a/editor/collaborate.mdx b/editor/collaborate.mdx index a5fa67588..42b5e7863 100644 --- a/editor/collaborate.mdx +++ b/editor/collaborate.mdx @@ -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 @ 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. diff --git a/editor/keyboard-shortcuts.mdx b/editor/keyboard-shortcuts.mdx index 4d05cb5ff..743c5f9b0 100644 --- a/editor/keyboard-shortcuts.mdx +++ b/editor/keyboard-shortcuts.mdx @@ -62,6 +62,7 @@ Use these shortcuts when editing in visual mode. | **Toggle suggesting mode** | Cmd + Shift + E | Ctrl + Shift + E | | **Component menu** | / | / | | **Emoji picker** | : + keyword | : + keyword | +| **Mention a teammate or page** | @ | @ | ### Smart substitutions diff --git a/editor/pages.mdx b/editor/pages.mdx index b667091a6..e7d10c180 100644 --- a/editor/pages.mdx +++ b/editor/pages.mdx @@ -2,7 +2,7 @@ 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 @@ -30,6 +30,15 @@ Type /image or /video to upload a file or pick one already For formatting images and using the Frame component, see [Images and embeds](/create/image-embeds). +## Mention teammates and pages + +In visual mode, type @ 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.