Refactor: update sidebar doc #2552
Conversation
WalkthroughThis pull request updates multiple documentation files by changing hyperlink references for "Project Settings" from the main menu to the sidebar. Several documents in both English and Chinese have been modified to reflect the new navigation structure. Additionally, the Spine API documentation has been revised to rename a parameter, remove an unnecessary configuration, and add a new rendering parameter. Documentation files related to the main menu have been removed and replaced with new sidebar documentation entries. Changes
Possibly related PRs
Suggested reviewers
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 (
|
github-actions
bot
added
the
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (14)
docs/en/basics/version.mdx(1 hunks)docs/en/graphics/2D/spine/other.mdx(1 hunks)docs/en/interface/menu.mdx(0 hunks)docs/en/interface/sidebar.mdx(1 hunks)docs/en/physics/overall.mdx(1 hunks)docs/en/xr/quickStart/develop.md(1 hunks)docs/zh/basics/version.mdx(1 hunks)docs/zh/graphics/2D/spine/other.mdx(1 hunks)docs/zh/interface/intro.mdx(1 hunks)docs/zh/interface/menu.mdx(0 hunks)docs/zh/interface/shortcut.mdx(1 hunks)docs/zh/interface/sidebar.mdx(1 hunks)docs/zh/physics/overall.mdx(1 hunks)docs/zh/xr/quickStart/develop.md(1 hunks)
💤 Files with no reviewable changes (2)
- docs/zh/interface/menu.mdx
- docs/en/interface/menu.mdx
✅ Files skipped from review due to trivial changes (6)
- docs/en/xr/quickStart/develop.md
- docs/en/basics/version.mdx
- docs/zh/physics/overall.mdx
- docs/zh/basics/version.mdx
- docs/zh/xr/quickStart/develop.md
- docs/zh/interface/shortcut.mdx
🧰 Additional context used
🪛 LanguageTool
docs/zh/interface/sidebar.mdx
[uncategorized] ~50-~50: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...m)。 ## 快照管理 快照管理功能允许用户保存某个项目的快照到历史记录中，万一项目出现数据丢失等问题，可以通过 Revet 快速恢复到之前保存的某个快照。...
(wa5)
⏰ 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)
🔇 Additional comments (5)
docs/zh/graphics/2D/spine/other.mdx (1)
10-10: LGTM!The link reference has been correctly updated to reflect the new sidebar navigation structure.
docs/zh/interface/intro.mdx (1)
31-31: LGTM!The updated description accurately reflects the expanded functionality of the sidebar.
docs/en/graphics/2D/spine/other.mdx (1)
10-10: LGTM!The link reference has been correctly updated to reflect the new sidebar navigation structure, maintaining consistency with the Chinese version.
docs/en/interface/sidebar.mdx (1)
1-52: LGTM!The new sidebar documentation is well-structured, comprehensive, and maintains consistency with the Chinese version.
docs/en/physics/overall.mdx (1)
15-15: LGTM! Documentation update is accurate and consistent.The navigation path to Project Settings has been correctly updated to reference the sidebar interface. The change aligns with the broader documentation updates and maintains consistency across the documentation.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2552 +/- ##
==========================================
+ Coverage 68.59% 68.90% +0.30%
==========================================
Files 961 961
Lines 100219 100266 +47
Branches 8598 8679 +81
==========================================
+ Hits 68749 69092 +343
+ Misses 31210 30914 -296
Partials 260 260
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/zh/interface/sidebar.mdx (1)
34-34: Fix typo in Chinese text.There's a typo in the Chinese text: "次布局" should be "此布局".
-用户可以通过此菜单唤起隐藏的面板，也可以根据自己的使用习惯保存当前面板布局，方便其他项目也使用次布局。 +用户可以通过此菜单唤起隐藏的面板，也可以根据自己的使用习惯保存当前面板布局，方便其他项目也使用此布局。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/zh/interface/sidebar.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/zh/interface/sidebar.mdx
[uncategorized] ~50-~50: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...m)。 ## 快照管理 快照管理功能允许用户保存某个项目的快照到历史记录中，万一项目出现数据丢失等问题，可以通过 Revert 快速恢复到之前保存的某个快照...
(wa5)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: codecov
- GitHub Check: e2e (22.x)
🔇 Additional comments (3)
docs/zh/interface/sidebar.mdx (3)
1-7: LGTM! Well-structured metadata.The metadata section is complete and properly formatted with all necessary fields.
48-52: LGTM! Clear and accurate snapshot management documentation.The snapshot management section is well-documented, and the button name is correctly specified as "Revert".
🧰 Tools
🪛 LanguageTool
[uncategorized] ~50-~50: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...m)。 ## 快照管理 快照管理功能允许用户保存某个项目的快照到历史记录中，万一项目出现数据丢失等问题，可以通过 Revert 快速恢复到之前保存的某个快照...(wa5)
46-46:❓ Verification inconclusive
Verify the documentation link.
Please ensure that the link to the multi-platform export documentation is valid and points to the correct location.
🏁 Script executed:
#!/bin/bash # Description: Check if the referenced documentation file exists fd -t f "platform.mdx" -E "node_modules"Length of output: 98
Verify Documentation Link Routing
- The referenced file exists in the repository as both:
docs/en/platform/platform.mdxdocs/zh/platform/platform.mdx- Since this sidebar is in the Chinese documentation (
docs/zh/interface/sidebar.mdx), please confirm that the link/docs/platform/platformis routed correctly to the Chinese version. If not, consider updating the link to/docs/zh/platform/platform.
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Update sidebar doc
Summary by CodeRabbit