Document editor comments feature #3372
Open
Conversation
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
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added documentation for the new comments feature in the web editor. Users can now add comments to text, view them in a sidebar, reply to threads, and resolve or delete discussions.
Files changed
editor/index.mdx- Added comments to key features listeditor/collaborate.mdx- Added comprehensive comments section with usage instructionsGenerated from feat: comment gutter icons + sidebar @rtbarnes
Note
Low Risk
Documentation-only changes with no impact on runtime behavior; risk is limited to potential user confusion if wording/behavior details are inaccurate.
Overview
Documents the new in-editor commenting workflow.
Adds a
Commentssection toeditor/collaborate.mdxcovering creating comments on selected text, viewing threads in the right sidebar (including unresolved count badge), replying, and resolving/deleting threads, plus a note about comments persisting in the repo and being branch-specific. Updateseditor/index.mdxto list Comments as a key editor feature.Written by Cursor Bugbot for commit 2dc8cf2. This will update automatically on new commits. Configure here.