Inline comments in Pages #356
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughAdds a new documentation page describing inline comments on Pages, updates capitalization in the Nested pages doc, and registers the new page in the exported sidebar under Knowledge management → Pages. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant PageUI as Page UI
participant Docs as Docs page content
rect rgb(230, 248, 255)
Note over Docs: New docs page added\ndocs/core-concepts/pages/inline-comments.mdx
end
User->>PageUI: Highlight text
PageUI->>Docs: Show inline comment composer
User->>Docs: Submit comment / mention user
Docs->>PageUI: Render inline thread (tag + replies)
PageUI->>User: Display comment, thread actions (reply, resolve, edit, delete)
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/core-concepts/pages/inline-comments.mdx(1 hunks)docs/core-concepts/pages/nested-pages.mdx(1 hunks)sidebars.ts(1 hunks)
🔇 Additional comments (9)
docs/core-concepts/pages/nested-pages.mdx (1)
2-2: LGTM! Capitalization consistency improved.The lowercase "pages" follows a consistent naming convention for better documentation uniformity.
Also applies to: 10-10
sidebars.ts (1)
137-137: LGTM! Sidebar entry correctly added.The new inline-comments entry is properly placed in the Knowledge management > Pages section and matches the file structure.
docs/core-concepts/pages/inline-comments.mdx (7)
7-12: LGTM! Component imports and heading structure are correct.The Tags component usage and Business tag annotation follow the established documentation pattern.
14-33: LGTM! Clear overview and scope explanation.The introductory sections effectively explain inline comments functionality and clearly differentiate the three page contexts with appropriate visibility information.
35-45: LGTM! Clear step-by-step instructions.The procedure for adding inline comments is well-structured and easy to follow.
56-56: Verify notification behavior for mentions.The commented-out line suggests uncertainty about whether mentioned team members receive notifications. Please verify this behavior and either uncomment the line if notifications are sent, or remove it if they aren't.
If you'd like, I can help you verify this by checking related code or documentation for notification implementation.
58-68: LGTM! Reply functionality well-documented.The threading explanation helps users understand how conversations are organized.
70-92: LGTM! Comment management features clearly explained.The filtering options and resolution workflow are well-documented with appropriate detail about default behaviors.
94-118: LGTM! Edit/delete and permissions clearly documented.The author-only editing restriction is appropriately highlighted, and permissions align well with the page scope descriptions provided earlier in the document.
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (6)
docs/core-concepts/pages/inline-comments.mdx (6)
45-45: Use exact UI label: “Comments panel”.Consistency with later references.
-3. Click the icon to open the comment panel on the right. +3. Click the icon to open the Comments panel on the right.
33-33: “Teamspace” capitalization consistency.If “Teamspace” is a proper product area, capitalize consistently; otherwise keep it lowercase everywhere. Please confirm preferred style.
-Only teamspace members have access to these comments. +Only Teamspace members have access to these comments.-Only teamspace members can view and comment. +Only Teamspace members can view and comment.Also applies to: 129-129
64-69: Mentions notifications: make behavior explicit (or remove).If mentions trigger notifications, surface it to users instead of an HTML comment.
4. Click on the person you want to mention, or use arrow keys and press Enter. - -<!-- Mentioned team members will receive a notification about the comment. --> +:::info +Mentioned teammates receive a notification about the comment. +:::
48-48: Specify the keyboard shortcut or drop the reference.Unspecified shortcut can confuse users. If it’s Cmd/Ctrl+Enter (or similar), name it; otherwise remove.
11-11: Plan tag wording.Consider “Business plan” to be explicit, and optionally add a one‑line note near the top stating availability.
118-118: Permissions nuance: can admins moderate others’ comments?Text says only the author can edit/delete their comments. If admins or workspace owners can moderate, clarify to avoid surprises.
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Note
Adds an Inline comments docs page, links it in the sidebar, and standardizes capitalization in the Nested pages doc.
docs/core-concepts/pages/inline-comments.mdxdetailing inline comments (overview, usage, mentions, attachments, replies, resolve/filter/edit/delete, permissions).core-concepts/pages/inline-commentstosidebars.tsunder Knowledge management > Pages.docs/core-concepts/pages/nested-pages.mdx(title and heading).Written by Cursor Bugbot for commit 1c1a5b6. This will update automatically on new commits. Configure here.
Summary by CodeRabbit