Skip to content
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

Merged
merged 7 commits into from
Jan 24, 2025
Merged

Refactor: update viewport doc #2531

merged 7 commits into from
Jan 24, 2025

Conversation

eyworldwide
Copy link
Member

@eyworldwide eyworldwide commented Jan 24, 2025

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

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

  • Documentation
    • Updated image sources in English and Chinese viewport documentation
    • Replaced multiple images with new URLs across various sections
    • Minor formatting adjustments in the documentation

@eyworldwide eyworldwide added the documentation Improvements or additions to documentation label Jan 24, 2025
@eyworldwide eyworldwide requested a review from luzhuang January 24, 2025 10:12
@eyworldwide eyworldwide added this to the 1.4 milestone Jan 24, 2025
Copy link

coderabbitai bot commented Jan 24, 2025

Walkthrough

The 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

File Change Summary
docs/en/interface/viewport.mdx Image sources replaced throughout the document
docs/zh/interface/viewport.mdx Multiple image URLs updated, including 6 specific image replacements with new URLs from different domains

Possibly related PRs

Poem

🐰 Viewport images, fresh and bright,
Pixels dancing in new light,
URLs changed with careful might,
Documentation's visual delight,
A rabbit's view, now crystal clear! 🖼️


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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@luzhuang luzhuang merged commit 58a11a4 into galacean:main Jan 24, 2025
7 checks passed
Copy link

@coderabbitai coderabbitai bot left a 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 keys

The 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 description

The 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

📥 Commits

Reviewing files that changed from the base of the PR and between 7814b04 and 4818e43.

📒 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)

Copy link

codecov bot commented Jan 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.61%. Comparing base (7814b04) to head (4818e43).
Report is 1 commits behind head on main.

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           
Flag Coverage Δ
unittests 68.61% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants