Document in-page mentions in the web editor - #7048
Draft
brandonmcconnell wants to merge 2 commits into
Draft
Conversation
Add a visual-mode mentions section on Create and edit pages, and cross-link comments, keyboard shortcuts, and the agent chat @ menu so teammates vs pages and email-on-insert are clear. Co-authored-by: Brandon McConnell <brandon@dreamthinkbuild.com>
Add a Mention component page and nav entry, wrap the comments distinction in a Note, and use kbd for @ across editor pages. Co-authored-by: Brandon McConnell <brandon@dreamthinkbuild.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
I can't access those repositories from this session, so I can't verify against implementation source. I'll report this rather than guess at changes. Unable to access the referenced implementation repositories, so no documentation changes were made. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation changes
Document in-page
@mentions in the web editor (Linear ENG-10574) and the built-in<Mention>component.Visual-mode
@inserts a teammate or a page. Teammates may get an email when you pick them from the menu. Source-mode authors use<Mention user="…" />or<Mention page="…" />(exactly one).Translations (
fr/,es/,zh/) are left to the automatic pipeline.Related implementation PRs:
Files
editor/pages.mdx— Mention teammates and pages under Edit content (visual-mode@)editor/comments.mdx—<Note>distinguishing comment@from page-body@editor/keyboard-shortcuts.mdx—@in the visual-mode content-actions tableeditor/agent.mdx— one sentence that agent-chat@does not open the in-content mention menu (the existing “mention a page for the agent” copy was already on main)components/mention.mdx— new component page (userorpage, not both)components/index.mdx— card under Draw attentiondocs.json— English nav entrycomponents/mentionWhy
Users should be able to type
@and know what happens for teammates vs pages, plus that an email may arrive. MDX authors need the component in the Components group. Comment@and agent@already existed, so those pages only disambiguate.Test plan
mint broken-links— no broken links foundvaleon the changed MDX files — 0 errors, 0 warnings, 0 suggestions/editor/pages#mention-teammates-and-pagesand/components/mentionresolve on preview@in visual mode and confirm the menu matches this copy (one of: user or page)@and agent@still behave as documentedFor Reviewers
When reviewing documentation PRs, please consider:
Technical accuracy
Clarity and completeness
User experience
Areas of uncertainty
mintlify/mint,mintlify/server, ormintlify/emailsfrom this environment (404). Copy follows the ENG-10574 brief.<Mention>examples on the component page: published user mentions flatten to a display name (needs a real org member), and page mentions flatten to regular links.commentReplyEmailsEnabled, and email CTA copy (“View mention”).