-
Notifications
You must be signed in to change notification settings - Fork 33
add: sharer drawing docs #251
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for hoppdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughDocumentation file updated to add instructions for a new drawing feature use case. The "Limitations" section is replaced with a new "How to use drawing as a Sharer" guide, including embedded video content, while the existing Controller-based drawing instructions are reorganized under a renamed section. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/src/content/docs/features/drawing.mdx`:
- Around line 31-35: The option label text "Persist until right click" should be
hyphenated for consistency; update the docs text in the drawing mode options
list (the list item that currently reads "Persist until right click") to use
"Persist until right-click" so the label is standardly hyphenated.
| 1. Click the drawing button in the call controls to enable drawing mode. | ||
| 2. You can configure the drawing mode from the three dots menu: | ||
| - **Temporary**: Drawings will be cleared after 3 seconds (default). | ||
| - **Persist until right click**: Drawings remain on screen until you right-click to clear them. | ||
| 3. To exit drawing mode, press **Escape**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hyphenate “right-click” in the option label.
Minor doc polish to match standard hyphenation.
🔤 Proposed edit
- - **Persist until right click**: Drawings remain on screen until you right-click to clear them.
+ - **Persist until right-click**: Drawings remain on screen until you right-click to clear them.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 1. Click the drawing button in the call controls to enable drawing mode. | |
| 2. You can configure the drawing mode from the three dots menu: | |
| - **Temporary**: Drawings will be cleared after 3 seconds (default). | |
| - **Persist until right click**: Drawings remain on screen until you right-click to clear them. | |
| 3. To exit drawing mode, press **Escape**. | |
| 1. Click the drawing button in the call controls to enable drawing mode. | |
| 2. You can configure the drawing mode from the three dots menu: | |
| - **Temporary**: Drawings will be cleared after 3 seconds (default). | |
| - **Persist until right-click**: Drawings remain on screen until you right-click to clear them. | |
| 3. To exit drawing mode, press **Escape**. |
🧰 Tools
🪛 LanguageTool
[grammar] ~34-~34: Use a hyphen to join words.
Context: ...ds (default). - Persist until right click: Drawings remain on screen until...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In `@docs/src/content/docs/features/drawing.mdx` around lines 31 - 35, The option
label text "Persist until right click" should be hyphenated for consistency;
update the docs text in the drawing mode options list (the list item that
currently reads "Persist until right click") to use "Persist until right-click"
so the label is standardly hyphenated.
Summary by CodeRabbit