Skip to content

Refactor: Update docs #2661

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

Merged
merged 9 commits into from
May 21, 2025
Merged

Conversation

eyworldwide
Copy link
Member

@eyworldwide eyworldwide commented May 15, 2025

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

Update docs:

  • Sidebar doc: Add new contents and update images.
  • Entity and hierarchy doc: remove duplicated contents and update images.
  • Viewport doc: replace an image.

Summary by CodeRabbit

  • Documentation
    • Expanded and reorganized entity management documentation with clearer sections, shortcut keys, and new UI images in both English and Chinese.
    • Condensed hierarchy panel documentation in both languages, referring users to entity documentation for details.
    • Updated sidebar interface guides with improved clarity, new screenshots, and additional notes on project settings, collaboration, and snapshot management.
    • Refined viewport interface documentation for clearer terminology, improved formatting, added new camera settings details, shortcut keys, and updated images.

Copy link

coderabbitai bot commented May 15, 2025

Walkthrough

The documentation for both English and Chinese interfaces and core concepts has been extensively revised for clarity, conciseness, and improved structure. Major sections on entity and hierarchy management were reorganized, expanded, or condensed, with updated images, clearer instructions, and new shortcut key tables. Sidebar and viewport documentation received editorial updates, refreshed screenshots, and enhanced explanations, with no changes to code or exported entities.

Changes

File(s) Change Summary
docs/en/core/entity.mdx
docs/zh/core/entity.mdx
Entity management documentation was extensively revised and expanded. Sections were reorganized, new images and shortcut key tables were added, and scripting examples and UI explanations were clarified and enriched.
docs/en/interface/hierarchy.mdx
docs/zh/interface/hierarchy.mdx
Hierarchy panel documentation was significantly condensed, removing detailed instructions, images, and shortcut tables. Now provides a brief overview and refers users to the entity documentation for details.
docs/en/interface/sidebar.mdx
docs/zh/interface/sidebar.mdx
Sidebar interface documentation was updated for clarity, with new images, reworded sections, and expanded explanations for project settings, member management, and snapshot management. Screenshots and UI references were refreshed.
docs/en/interface/viewport.mdx Viewport documentation was edited for consistency and clarity, with terminology improvements, reformatted tables, renamed tools, and clearer descriptions of navigation and toolbar functions.
docs/zh/interface/viewport.mdx Camera preview window section updated with a new image and a reformatted property table using numbered labels for each property. No textual or functional changes.

Poem

🐇
In docs we burrow deep and wide,
With clearer words our guides reside.
Images fresh and tables neat,
Shortcut keys at your fingertips meet.
Hierarchies trimmed, sidebars bright—
Hop along, the docs feel light!
— A rabbit, delighting in every rewrite.

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


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.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 15, 2025
@eyworldwide eyworldwide added this to the 1.5 milestone May 15, 2025
@eyworldwide eyworldwide requested a review from MrKou47 May 15, 2025 06:28
Copy link

codecov bot commented May 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.58%. Comparing base (d069479) to head (ac64827).
Report is 1 commits behind head on dev/1.5.

Additional details and impacted files
@@             Coverage Diff             @@
##           dev/1.5    #2661      +/-   ##
===========================================
- Coverage    68.68%   68.58%   -0.11%     
===========================================
  Files          971      974       +3     
  Lines       102088   102468     +380     
  Branches      8781     8807      +26     
===========================================
+ Hits         70119    70277     +158     
- Misses       31703    31923     +220     
- Partials       266      268       +2     
Flag Coverage Δ
unittests 68.58% <ø> (-0.11%) ⬇️

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.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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: 2

🧹 Nitpick comments (30)
docs/zh/interface/viewport.mdx (2)

90-90: Add descriptive alt text for accessibility.

Good catch adding an alt attribute to the new preview image. Instead of a filename, consider a meaningful description (e.g. "相机预览窗口示例图"), which aids screen-reader users.


92-97: Consistency with Chinese numbering style.

You've prefixed table entries with “1.”, “2.” etc. In Chinese contexts it's idiomatic to use “1、拖动” rather than “1. 拖动”. Consider switching to Chinese punctuation for consistency.

docs/en/interface/hierarchy.mdx (1)

9-9: Hyphenate compound adjective.

“The hierarchy panel is located on the far left side of the editor” → add a hyphen:

-The hierarchy panel is located on the far left side of the editor
+The hierarchy panel is located on the far-left side of the editor
🧰 Tools
🪛 LanguageTool

[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... The hierarchy panel is located on the far left side of the editor and displays all nod...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

docs/zh/interface/hierarchy.mdx (1)

13-13: Fix Chinese grammar with locative.

Use “在层级面板中” rather than “在层级面板,” to correctly mark location:

-在层级面板,你可以编辑实体的基本属性和管理组件…
+在层级面板中,你可以编辑实体的基本属性和管理组件…
docs/zh/interface/sidebar.mdx (5)

22-22: Add alt attributes to new images.

New <Image> tags lack alt. For accessibility, please supply descriptive alt text for each screenshot.

Also applies to: 34-34, 57-57


32-33: Avoid repetitive phrasing.

“为了快速进行项目设置,也可以从项目列表页进行项目设置” repeats “项目设置”. Consider:

-为了快速进行项目设置,也可以从项目列表页进行项目设置。
+为了快速进行项目设置,也可以从项目列表页直接进入该设置界面。

38-38: Correct typo “次布局” → “此布局”.

-方便其他项目也使用次布局。
+方便其他项目也使用此布局。

44-44: Refine Chinese wording.

“通过邮箱搜索到新成员” → remove “到”:

-你可以通过邮箱搜索到新成员…
+你可以通过邮箱搜索新成员…

55-55: Clarify UI element.

Add a classifier for “Add Snapshot”:

-用户可以在菜单中选择 **Add Snapshot**。
+用户可以在菜单中选择 **Add Snapshot** 按钮。
docs/en/interface/sidebar.mdx (2)

22-22: Add alt attributes to new images.

The new <Image> components should include meaningful alt text to support screen readers.

Also applies to: 34-34, 56-56, 60-60


44-44: Use more formal relative pronoun.

“partners you want to collaborate with” →

-You can also generate a shareable link to send to partners you want to collaborate with.
+You can also generate a shareable link to send to partners with whom you want to collaborate.
🧰 Tools
🪛 LanguageTool

[style] ~44-~44: Consider using an alternative to strengthen your wording.
Context: ... shareable link to send to partners you want to collaborate with. <Image src="https...

(WANT_KEEN)

docs/zh/core/entity.mdx (10)

8-8: Consider simplifying the heading
The Chinese header "实体的管理" is more concise and idiomatic as "实体管理". Removing "的" aligns with common documentation style.


12-12: Unify terminology for adding entities
The sentence mixes "新增" and "添加". For consistency, choose one term (e.g., use "添加实体" throughout or stick with "新增实体") and apply it uniformly.


22-22: Grammar: missing "的" before 实体
In "挂载光源组件实体" and "挂载 3D/2D 基础渲染组件的实体", consider revising to include "的" and remove extra spaces:

- 挂载光源组件实体,以及挂载 3D/2D 基础渲染组件的实体。
+ 挂载光源组件的实体,以及挂载3D/2D基础渲染组件的实体。

30-30: Use correct phrasing for shortcut description
Replace "快捷键是 Delete" with "快捷键为 Delete" or "按 Delete 键" for more natural Chinese.


32-32: Clarify right-click action
Modify to "右键点击某个实体,然后选择 “Delete”" to clearly indicate the menu selection.


41-41: Unify term “复制” vs “拷贝”
The heading uses "拷贝实体", but the shortcut table uses "复制实体". For consistency, choose either "复制"或“拷贝”并统一。


43-43: Reduce repetitive wording
The sentence repeats "拷贝" three times. Consider:

- 拷贝实体会拷贝选中实体及其所有的子实体,实体所带的组件都会被拷贝。
+ 复制选中实体及其所有子实体,并保留其组件。

45-47: Standardize UI labels casing
Use capitalized UI labels consistently: replace Duplicated with Duplicate in code markup, and change copy/paste to Copy/Paste.


54-54: Correct adverbial modifier
Change "为了更好的组织实体" to "为了更好地组织实体" to use the proper adverbial form.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~54-~54: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:好"地"组织
Context: ...style={{zoom:"50%"}} /> ### 实体排序 为了更好的组织实体,你可以通过拖拽的方式来排序实体。选中一个实体后,可以通过鼠标左键拖拽来...

(wb4)


65-65: Use Chinese punctuation
Replace the commas "," with fullwidth commas "," in "需要注意的是, 此处对实体显示状态的调整仅是工作区的修改, ..." for correct Chinese punctuation.

docs/en/core/entity.mdx (5)

12-12: Simplify repetitive phrasing
"You can add empty entities or quickly add entities with relevant functional components attached" repeats "add". Consider:

- You can add empty entities or quickly add entities with relevant functional components attached, such as entities with camera components...
+ You can create empty entities or entities preconfigured with components such as cameras...

30-30: Improve delete action phrasing
Use a clearer imperative and combine actions:

- 1. Select the entity to be deleted -> Click the delete button, the shortcut key is <Kbd>Delete</Kbd>
+ 1. Select the entity, then click the Delete button or press <Kbd>Delete</Kbd>.

32-32: Clarify context menu instruction
Revise to "Right-click an entity, then select 'Delete' from the context menu." for clarity.


47-47: Capitalize UI commands
Use Copy and Paste (not lowercase) to match menu labels.


62-62: Use "visibility" instead of "display/hide state"
Replace "toggle the entity's display/hide state" with "toggle the entity's visibility in the scene" for clarity.

docs/en/interface/viewport.mdx (4)

11-11: Refine phrasing: avoid redundancy
Rather than "interactive interface", consider "interactive panel" or simply "viewport":

- The viewport window is an interactive interface used for...
+ The viewport window is an interactive panel used for...

17-17: Clarify navigation modes
Consider indicating how users switch modes (e.g., toolbar button or shortcut). E.g.:

- There are two modes for navigating the scene: standard mode and flight mode.
+ The viewport offers two navigation modes—standard and flight—toggle between them via the button in the toolbar.

41-41: Add alt text to toolbar image
The <Image> tag here lacks an alt attribute. For accessibility, please add meaningful alt text, e.g.:

- <Image src="...viewport-toolbar.png" style={{zoom:"50%"}} />
+ <Image src="...viewport-toolbar.png" alt="Viewport toolbar icons" style={{zoom:"50%"}} />

94-94: Consistent table description voice
In the preview table, change the "Position" row from an imperative to a noun phrase for consistency:

- 2. Position     | Position the camera in the scene
+ 2. Position     | Camera position in the scene
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between ea51cf3 and be8e918.

📒 Files selected for processing (8)
  • docs/en/core/entity.mdx (1 hunks)
  • docs/en/interface/hierarchy.mdx (1 hunks)
  • docs/en/interface/sidebar.mdx (1 hunks)
  • docs/en/interface/viewport.mdx (1 hunks)
  • docs/zh/core/entity.mdx (1 hunks)
  • docs/zh/interface/hierarchy.mdx (1 hunks)
  • docs/zh/interface/sidebar.mdx (2 hunks)
  • docs/zh/interface/viewport.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/zh/interface/sidebar.mdx

[uncategorized] ~54-~54: 数词与名词之间一般应存在量词,可能缺少量词。
Context: ...m)。 ## 快照管理 快照管理功能允许用户保存某个项目的快照到历史记录中,万一项目出现数据丢失等问题。用户可以在菜单中选择 Add Snapshot 。 ...

(wa5)

docs/en/interface/hierarchy.mdx

[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... The hierarchy panel is located on the far left side of the editor and displays all nod...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

docs/en/interface/sidebar.mdx

[style] ~44-~44: Consider using an alternative to strengthen your wording.
Context: ... shareable link to send to partners you want to collaborate with. <Image src="https...

(WANT_KEEN)

docs/en/core/entity.mdx

[uncategorized] ~137-~137: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...eases the object from the hierarchy tree and it will not be shown in the scene. To c...

(COMMA_COMPOUND_SENTENCE)


[style] ~137-~137: ‘completely destroy’ might be wordy. Consider a shorter alternative.
Context: ...d it will not be shown in the scene. To completely destroy it, additionally: ```typescript newEnt...

(EN_WORDINESS_PREMIUM_COMPLETELY_DESTROY)

docs/zh/core/entity.mdx

[uncategorized] ~54-~54: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:好"地"组织
Context: ...style={{zoom:"50%"}} /> ### 实体排序 为了更好的组织实体,你可以通过拖拽的方式来排序实体。选中一个实体后,可以通过鼠标左键拖拽来...

(wb4)

docs/en/interface/viewport.mdx

[uncategorized] ~95-~95: Possible missing preposition found.
Context: ... | | 2. Position | Position the camera in the scene | | 3. Switch A...

(AI_HYDRA_LEO_MISSING_OF)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: e2e (22.x)
  • GitHub Check: codecov
  • GitHub Check: build (22.x, windows-latest)
🔇 Additional comments (7)
docs/zh/core/entity.mdx (6)

15-17: Skip
Image insertion and right-click instruction look correct. No changes needed.


24-24: Skip
Inspector panel link insertion is correct.


37-39: Skip
Warning callout content is clear and accurate.


58-58: Skip
Search box description is clear.


70-80: Skip
Shortcut keys table and related headings look consistent.


81-102: Skip
Editing Entities section flows correctly with no issues.

docs/en/interface/viewport.mdx (1)

99-101: Skip
The final synchronization note and image are clear.

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

♻️ Duplicate comments (2)
docs/zh/core/entity.mdx (1)

62-62: Fix duplicated word
Remove the extra “实体” so the sentence reads “每个实体右侧都有一个眼睛按钮”。

docs/en/core/entity.mdx (1)

45-45: UI label consistency: use "Duplicate"
The menu command should match the UI label. Replace Duplicated with Duplicate.

🧹 Nitpick comments (5)
docs/zh/core/entity.mdx (3)

54-54: Refine adverb usage
建议将“为了更好的组织实体,你可以通过拖拽的方式来排序实体”改为“为了更好地组织实体,你可以通过拖拽的方式来排序实体”。

🧰 Tools
🪛 LanguageTool

[uncategorized] ~54-~54: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:好"地"组织
Context: ...style={{zoom:"50%"}} /> ### 实体排序 为了更好的组织实体,你可以通过拖拽的方式来排序实体。选中一个实体后,可以通过鼠标左键拖拽来...

(wb4)


65-66: Use proper Chinese punctuation
将“需要注意的是, 此处对实体显示状态的调整仅是工作区的修改, 而非在 … 中的 isActive 的属性。”中英文逗号替换为中文逗号/冒号,例如:

-需要注意的是, 此处对实体显示状态的调整仅是工作区的修改, 而非在 … 中的 `isActive` 的属性。
+需要注意的是,此处对实体显示状态的调整仅是工作区的修改,而非在 … 中的 `isActive` 属性。

14-15: Add alt text to <Image> components
为所有 <Image> 标签补充 alt 属性,以提高无障碍可访问性。例如:

-<Image src="…png" style={{zoom:"50%"}} />
+<Image src="…png" alt="层级面板中新建实体按钮截图" style={{zoom:"50%"}} />

Also applies to: 19-20, 34-35, 49-50, 87-88, 101-103

docs/en/core/entity.mdx (2)

137-137: Fix comma and improve clarity
Add a comma before “and” to separate the clauses, and simplify wording by removing “additionally”. For example:

-It is worth noting that this method simply releases the object from the hierarchy tree and it will not be shown in the scene. To completely destroy it, additionally:
+It is worth noting that this method simply releases the object from the hierarchy tree, and it will not be shown in the scene. To destroy it completely:
🧰 Tools
🪛 LanguageTool

[uncategorized] ~137-~137: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...eases the object from the hierarchy tree and it will not be shown in the scene. To c...

(COMMA_COMPOUND_SENTENCE)


[style] ~137-~137: ‘completely destroy’ might be wordy. Consider a shorter alternative.
Context: ...d it will not be shown in the scene. To completely destroy it, additionally: ```typescript newEnt...

(EN_WORDINESS_PREMIUM_COMPLETELY_DESTROY)


14-16: Add descriptive alt text to images
Include an alt attribute on all <Image> components to improve accessibility. For example:

-<Image src="…" style={{zoom:"50%"}} />
+<Image src="…" alt="Screenshot of hierarchy panel showing add entity action" style={{zoom:"50%"}} />

Also applies to: 19-21, 34-36, 49-51, 87-89, 100-103

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between be8e918 and 9f10df5.

📒 Files selected for processing (2)
  • docs/en/core/entity.mdx (1 hunks)
  • docs/zh/core/entity.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/zh/core/entity.mdx

[uncategorized] ~54-~54: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:好"地"组织
Context: ...style={{zoom:"50%"}} /> ### 实体排序 为了更好的组织实体,你可以通过拖拽的方式来排序实体。选中一个实体后,可以通过鼠标左键拖拽来...

(wb4)

docs/en/core/entity.mdx

[uncategorized] ~137-~137: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...eases the object from the hierarchy tree and it will not be shown in the scene. To c...

(COMMA_COMPOUND_SENTENCE)


[style] ~137-~137: ‘completely destroy’ might be wordy. Consider a shorter alternative.
Context: ...d it will not be shown in the scene. To completely destroy it, additionally: ```typescript newEnt...

(EN_WORDINESS_PREMIUM_COMPLETELY_DESTROY)

⏰ 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

@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 (5)
docs/zh/core/entity.mdx (5)

8-24: Add meaningful alt text for images in “新增实体” section
The <Image> components on lines 15 and 20 lack alt attributes, which are important for accessibility and SEO. Please add descriptive alt text, for example:

 <Image
- src="https://.../image-20250515120040706.png" style={{zoom:"50%"}} />
+ src="https://.../image-20250515120040706.png"
+ alt="层级树面板新增实体按钮"
+ style={{zoom:"50%"}} />

52-55: 修正语法:使用“更好地”而非“更好的”
第 54 行“为了更好的组织实体”应改为“为了更好地组织实体”:

- 为了更好的组织实体
+ 为了更好地组织实体
🧰 Tools
🪛 LanguageTool

[uncategorized] ~54-~54: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:好"地"组织
Context: ...style={{zoom:"50%"}} /> ### 实体排序 为了更好的组织实体,你可以通过拖拽的方式来排序实体。选中一个实体后,可以通过鼠标左键拖拽来...

(wb4)


68-79: 快捷键表格完善
表格列出了常用实体操作的所有快捷键。建议将“删除”操作在前文“删除实体”部分的描述与此处 <Kbd>Backspace</Kbd> 或 <Kbd>Delete</Kbd> 保持一致,以避免混淆。


82-90: Add alt text for inspector panel screenshot
第 88 行的 <Image> 缺少 alt 属性,请添加有意义的描述,例如:

 <Image
- src="https://.../image-20250515114745494.png" style={{zoom:"50%"}} />
+ src="https://.../image-20250515114745494.png"
+ alt="检查器面板基本信息示例"
+ style={{zoom:"50%"}} />

97-104: Add alt text for component management screenshot
第 101–104 行的组件管理视图同样需要 alt 属性,例如:

 <Image
- src="https://.../image-20250515153549864.png" style={{zoom:"50%"}} />
+ src="https://.../image-20250515153549864.png"
+ alt="检查器面板组件列表示例"
+ style={{zoom:"50%"}} />
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 9f10df5 and ac64827.

📒 Files selected for processing (1)
  • docs/zh/core/entity.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/zh/core/entity.mdx

[uncategorized] ~54-~54: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:好"地"组织
Context: ...style={{zoom:"50%"}} /> ### 实体排序 为了更好的组织实体,你可以通过拖拽的方式来排序实体。选中一个实体后,可以通过鼠标左键拖拽来...

(wb4)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: e2e (22.x)
  • GitHub Check: build (22.x, windows-latest)
  • GitHub Check: codecov
🔇 Additional comments (6)
docs/zh/core/entity.mdx (6)

26-39: 删除实体小节清晰且警示到位
“删除实体”部分结构合理,操作步骤与警示 Callout 有效提醒了级联删除风险。


41-51: Verify UI labels and add keyboard shortcuts for 复制/粘贴
当前文中提到通过 Duplicated 及命令 copy/paste 实现拷贝,但未给出快捷键。请确认编辑器中菜单项究竟是 “Duplicate” 还是 “Duplicated”,以及是否有相应的键盘组合(例如 Ctrl+C / Ctrl+V⌘+C / ⌘+V),并在文中补充。


56-59: 搜索功能描述准确
“搜索”子节对模糊搜索的说明清晰明了。


60-67: 隐藏实体说明明确
“隐藏实体”子节的 Callout 清晰说明了眼睛图标仅影响工作区显示,与 isActive 属性区分合理。


92-95: 基本信息表格清晰
编号、名称与说明三列对实体属性的说明完整且排版正确。


106-189: 脚本使用示例代码正确且完整
TypeScript 代码片段均已使用合适的代码块标记、正确的 API 调用示例及链接,满足文档需求。

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

♻️ Duplicate comments (1)
docs/en/core/entity.mdx (1)

45-45: UI label consistency: use “Duplicate”
The menu command should match the actual UI label. Replace

`Duplicated`

with

- `Duplicated`
+ `Duplicate`
🧹 Nitpick comments (3)
docs/zh/core/entity.mdx (3)

32-32: 统一按键表现:包裹按键文本
为保证文档中按键样式一致,建议将

2. 右键某个实体 -> Delete

替换为

- 2. 右键某个实体 -> Delete
+ 2. 右键某个实体 -> <Kbd>Delete</Kbd>

45-45: UI 操作一致性:使用 “Duplicate”
文档中应与实际界面保持一致,将菜单命令从 Duplicated 更正为 Duplicate

- 通过 `Duplicated` 在同层级下快速克隆该实体
+ 通过 `Duplicate` 在同层级下快速克隆该实体

54-54: 中文规范:副词+“地”修饰动词
动词修饰请使用“副词+地”的形式,建议将

为了更好的组织实体

替换为

- 为了更好的组织实体
+ 为了更好地组织实体
🧰 Tools
🪛 LanguageTool

[uncategorized] ~54-~54: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:好"地"组织
Context: ...style={{zoom:"50%"}} /> ### 实体排序 为了更好的组织实体,你可以通过拖拽的方式来排序实体。选中一个实体后,可以通过鼠标左键拖拽来...

(wb4)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between ac64827 and 69ed525.

📒 Files selected for processing (4)
  • docs/en/core/entity.mdx (1 hunks)
  • docs/en/interface/viewport.mdx (1 hunks)
  • docs/zh/core/entity.mdx (2 hunks)
  • docs/zh/interface/viewport.mdx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/zh/interface/viewport.mdx
  • docs/en/interface/viewport.mdx
🧰 Additional context used
🪛 LanguageTool
docs/en/core/entity.mdx

[uncategorized] ~137-~137: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...eases the object from the hierarchy tree and it will not be shown in the scene. To c...

(COMMA_COMPOUND_SENTENCE)


[style] ~137-~137: ‘completely destroy’ might be wordy. Consider a shorter alternative.
Context: ...d it will not be shown in the scene. To completely destroy it, additionally: ```typescript newEnt...

(EN_WORDINESS_PREMIUM_COMPLETELY_DESTROY)

docs/zh/core/entity.mdx

[uncategorized] ~54-~54: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:好"地"组织
Context: ...style={{zoom:"50%"}} /> ### 实体排序 为了更好的组织实体,你可以通过拖拽的方式来排序实体。选中一个实体后,可以通过鼠标左键拖拽来...

(wb4)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: e2e (22.x)
  • GitHub Check: codecov
  • GitHub Check: build (22.x, windows-latest)

Copy link
Collaborator

@cptbtptpbcptdtptp cptbtptpbcptdtptp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@cptbtptpbcptdtptp cptbtptpbcptdtptp merged commit a6c1128 into galacean:dev/1.5 May 21, 2025
6 of 7 checks passed
@cptbtptpbcptdtptp cptbtptpbcptdtptp mentioned this pull request May 21, 2025
10 tasks
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