8000 fix: benchmark doc typo by MrKou47 · Pull Request #2245 · galacean/engine · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix: benchmark doc typo #2245

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 19, 2024
Merged

fix: benchmark doc typo #2245

merged 1 commit into from
Jul 19, 2024

Conversation

MrKou47
Copy link
Member
@MrKou47 MrKou47 commented Jul 18, 2024 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Documentation
    • Updated benchmark documentation to include rendering and animation performance comparisons of three engines.
    • Added new test scenarios for particle system performance.
    • Improved details on 2D rendering test performance.

@coderabbitai coderabbitai
Copy link
coderabbitai bot commented Jul 18, 2024 •
edited
Loading

Walkthrough

The benchmark documentation has been enhanced to provide more detailed performance comparisons across three engines. This includes updates to testing scenarios for glTF models, PointerLights, and animations, as well as new particle system and 2D rendering performance tests.

Changes

File Change Summary
docs/.../benchmark.mdx (EN) Updated benchmark scenarios focusing on rendering performance of engines with different test cases.
docs/.../benchmark.mdx (ZH) Added and refined benchmark tests for glTF models, PointerLights, animations, particle systems, and 2D sprites.

Poem

Amidst the codes and engines bright,
Benchmarks dance in the night.
Models load and lights do gleam,
Animations play in a seamless dream.
Particles sparkle, sprites take flight,
Performance tested, everything's right.
🐇✨

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

@MrKou47 MrKou47 requested a review from GuoLei1990 July 18, 2024 10:17
coderabbitai[bot]
coderabbitai bot reviewed Jul 18, 2024
View reviewed changes
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between eb3d17f and 614227e.

Files selected for processing (2)
  • docs/en/quick-start/benchmark.mdx (1 hunks)
  • docs/zh/quick-start/benchmark.mdx (2 hunks)
Additional comments not posted (8)
docs/zh/quick-start/benchmark.mdx (4)

18-18: LGTM!

The description of the benchmark test for rendering performance with glTF models and PointerLights is clear and complete.

24-26: LGTM!

The description of the benchmark test for animation performance with glTF models and animations is clear and complete.

28-28: LGTM!

The description of the benchma A450 rk test for particle system performance is clear and complete.

38-38: LGTM!

The description of the benchmark test for 2D rendering performance is clear and complete.

docs/en/quick-start/benchmark.mdx (4)

18-18: LGTM!

The description of the benchmark test for rendering performance with glTF models and PointerLights is clear and complete.

24-26: LGTM!

The description of the benchmark test for animation performance with glTF models and animations is clear and complete.

28-28: LGTM!

The description of the benchmark test for particle system performance is clear and complete.

Line range hint 38-38:
LGTM!

The description of the benchmark test for 2D rendering performance is clear and complete.

@GuoLei1990 GuoLei1990 added the documentation Improvements or additions to documentation label Jul 19, 2024
@MrKou47 MrKou47 merged commit f0655f9 into dev/1.3 Jul 19, 2024
6 checks passed
@MrKou47 MrKou47 deleted the doc/benchmark-typo branch July 19, 2024 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@GuoLei1990 GuoLei1990 Awaiting requested review from GuoLei1990

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@MrKou47 @GuoLei1990
0