-
-
Notifications
You must be signed in to change notification settings - Fork 310
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
Refactor: update viewport doc #2531
Conversation
WalkthroughThe pull request involves updating image sources in the viewport documentation for both English and Chinese versions. The changes primarily focus on replacing existing image URLs with new ones across various sections of the document, including the viewport interface, toolbar, auxiliary element settings, scene camera settings, and preview sections. The textual content and overall document structure remain unchanged, with only the visual representations being updated. Changes
Possibly related PRs
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
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: 0
🧹 Nitpick comments (2)
docs/en/interface/viewport.mdx (2)
Line range hint
24-32
: Maintain consistent formatting for shortcut keysThe shortcut keys in the Flying mode section lack backticks (`), while they are present in the Standard mode section. This inconsistency might confuse readers.
Apply backticks consistently:
-| **Flying** | Look around camera | alt + Right Mouse Button | -| | Move forward | Up Arrow or Right Mouse Button + W | -| | Move backward | Down Arrow or Right Mouse Button + S | -| | Strafe left | Left Arrow or Right Mouse Button + A | -| | Strafe right | Right Arrow or Right Mouse Button + D | -| | Move up | Right Mouse Button + E | -| | Move down | Right Mouse Button + Q | +| **Flying** | Look around camera | `alt` + Right Mouse Button | +| | Move forward | `Up Arrow` or Right Mouse Button + `W` | +| | Move backward | `Down Arrow` or Right Mouse Button + `S` | +| | Strafe left | `Left Arrow` or Right Mouse Button + `A` | +| | Strafe right | `Right Arrow` or Right Mouse Button + `D` | +| | Move up | Right Mouse Button + `E` | +| | Move down | Right Mouse Button + `Q` |
63-63
: Fix grammar in Navigation Gizmo descriptionThe preposition "at" should be replaced with "in" when used with "corner".
-| Navigation Gizmo | Used to display the current direction of the scene camera and can be quickly modified by mouse operation to adjust the view and projection mode (orthographic/perspective). It will appear at the bottom right corner of the screen when open.<br /><Image src="https://mdn.alipayobjects.com/huamei_qbugvr/afts/img/A*tooGS4MTpTUAAAAAAAAAAAAADtKFAQ/original" style={{zoom:"50%"}} /> | +| Navigation Gizmo | Used to display the current direction of the scene camera and can be quickly modified by mouse operation to adjust the view and projection mode (orthographic/perspective). It will appear in the bottom right corner of the screen when open.<br /><Image src="https://mdn.alipayobjects.com/huamei_qbugvr/afts/img/A*tooGS4MTpTUAAAAAAAAAAAAADtKFAQ/original" style={{zoom:"50%"}} /> |🧰 Tools
🪛 LanguageTool
[grammar] ~63-~63: The usual preposition to use with “corner” is “in”, not “on”. Did you mean “in the bottom right corner”?
Context: ...thographic/perspective). It will appear at the bottom right corner of the screen when open.
<Image sr...(ON_IN_THE_CORNER)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/en/interface/viewport.mdx
(6 hunks)docs/zh/interface/viewport.mdx
(5 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/zh/interface/viewport.mdx
🧰 Additional context used
🪛 LanguageTool
docs/en/interface/viewport.mdx
[grammar] ~63-~63: The usual preposition to use with “corner” is “in”, not “on”. Did you mean “in the bottom right corner”?
Context: ...thographic/perspective). It will appear at the bottom right corner of the screen when open.
<Image sr...
(ON_IN_THE_CORNER)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: build (22.x, windows-latest)
- GitHub Check: codecov
- GitHub Check: e2e (22.x)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2531 +/- ##
=======================================
Coverage 68.61% 68.61%
=======================================
Files 957 957
Lines 100125 100125
Branches 8572 8569 -3
=======================================
+ Hits 68703 68705 +2
+ Misses 31166 31164 -2
Partials 256 256
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Please check if the PR fulfills these requirements
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
What is the current behavior? (You can also link to an open issue here)
What is the new behavior (if this is a feature change)?
Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
Other information:
Summary by CodeRabbit