docs: add benchmark doc #2229
docs: add benchmark doc #2229
Conversation
WalkthroughThe new Changes
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## dev/1.3 #2229 +/- ##
===========================================
+ Coverage 68.27% 69.35% +1.08%
===========================================
Files 468 523 +55
Lines 24353 27304 +2951
Branches 3632 4067 +435
===========================================
+ Hits 16626 18936 +2310
- Misses 6400 6891 +491
- Partials 1327 1477 +150 ☔ View full report in Codecov by Sentry. |
![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
Outside diff range, codebase verification and nitpick comments (1)
docs/quick-start/benchmark.mdx (1)
23-29: Clarify the use ofthree-nebulafor Three.js.It's mentioned that Three.js does not have a native particle system, and
three-nebulais used instead. Clarifying this could help avoid confusion about the capabilities of Three.js.- > Three.js 自身没有 Particle System，也没有目前仍在维护的首选三方库。类似效果一般通过开发者独力实现。因此我们在此项测试中使用 `three-nebula` 来代指 Three.js 的粒子系统 + > 注意：Three.js 自身不包含 Particle System。在此基准测试中，我们使用 `three-nebula`，一个三方库，来模拟 Three.js 的粒子系统效果。
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/quick-start/benchmark.mdx (1 hunks)
Additional comments not posted (3)
docs/quick-start/benchmark.mdx (3)
16-20: Approve the basic rendering test description.The description of the rendering tests using glTF models is clear and the custom component
<BenchmarkDisplay>is used correctly.
31-35: Approve the 2D rendering test description.The description of the 2D rendering tests is clear and concise, and the custom component
<BenchmarkDisplay>is used correctly.
8-14: Verify the benchmark repository link.The link to the benchmark repository is provided, but it's crucial to ensure that it is accessible and contains the relevant source code.
Verification successful
Verification successful.
The link to the benchmark repository is correct and accessible.
- The repository title confirms it is the benchmark for Galacean.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check if the benchmark repository link is accessible and contains the relevant source code. curl -s https://github.com/galacean/benchmark | grep -o "<title>.*</title>"Length of output: 143
| ## 总结 | ||
|
|
||
| 我们选择了 Babylon.js，Three.js 以及 PixiJS 这几款引擎进行测试，是因为它们都是当前最受欢迎的游戏引擎，并且在开发的过程中，它们一直是我们努力去赶超的目标。我们希望通过这些基准测试为社区提供透明以及可比较的性能信息。 | ||
|
|
||
| 如果你希望我们包括你的游戏引擎，或者认为这些测试存在改进建议，欢迎随时开启一个 [issue](https://github.com/galacean/benchmark/issues)。 |
There was a problem hiding this comment.
Enhance the invitation for community engagement.
The invitation to open issues for suggestions or to include other engines is good, but it could be more engaging.
- 如果你希望我们包括你的游戏引擎，或者认为这些测试存在改进建议，欢迎随时开启一个 (https://github.com/galacean/benchmark/issues)。
+ 我们欢迎社区成员提出改进建议或请求包括更多游戏引擎。如果你有任何想法，请通过开启一个 (https://github.com/galacean/benchmark/issues) 与我们分享。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.
| ## 总结 | |
| 我们选择了 Babylon.js，Three.js 以及 PixiJS 这几款引擎进行测试，是因为它们都是当前最受欢迎的游戏引擎，并且在开发的过程中，它们一直是我们努力去赶超的目标。我们希望通过这些基准测试为社区提供透明以及可比较的性能信息。 | |
| 如果你希望我们包括你的游戏引擎，或者认为这些测试存在改进建议，欢迎随时开启一个 [issue](https://github.com/galacean/benchmark/issues)。 | |
| ## 总结 | |
| 我们选择了 Babylon.js，Three.js 以及 PixiJS 这几款引擎进行测试，是因为它们都是当前最受欢迎的游戏引擎，并且在开发的过程中，它们一直是我们努力去赶超的目标。我们希望通过这些基准测试为社区提供透明以及可比较的性能信息。 | |
| 我们欢迎社区成员提出改进建议或请求包括更多游戏引擎。如果你有任何想法，请通过开启一个 [issue](https://github.com/galacean/benchmark/issues) 与我们分享。 |
GuoLei1990
added
documentation
Add benchmark documentation in Chinese
Summary by CodeRabbit