Skip to content

Add performance_tuning to jetty/tutorials#683

Open
ammaarrahmed wants to merge 5 commits intogazebosim:masterfrom
ammaarrahmed:jetty/tutorials/performancetuning
Open

Add performance_tuning to jetty/tutorials#683
ammaarrahmed wants to merge 5 commits intogazebosim:masterfrom
ammaarrahmed:jetty/tutorials/performancetuning

Conversation

@ammaarrahmed
Copy link
Copy Markdown

New feature

Part of #673

Summary

Add a Jetty performance tuning guide with a short set of practical tips for improving simulation performance and real-time factor.

This PR keeps the first pass small:

  • adds a new performance_tuning.md page under Jetty tutorials
  • links it from the Jetty tutorials landing page and sidebar
  • focuses on documented tuning knobs such as physics step size, sensor update rates, simpler collision / visual models, rendering settings, and GPU setup
  • links out to existing docs or external references for more specialized options instead of trying to cover everything in one page

Checklist

  • Signed all commits for DCO
  • Added a screen capture or video to the PR description that demonstrates the feature
  • Added tests
  • Added example and/or tutorial
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • Updated Bazel files (if adding new files). Created an issue otherwise.
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers
  • Was GenAI used to generate this PR? If so, make sure to add "Generated-by" to your commits. (See this policy for more info.)

Generated-by: copilot for .md content

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by and Generated-by messages.

Backports: If this is a backport, please use Rebase and Merge instead.

Signed-off-by: Ammaar Ahmed <ammaarlatif53@gmail.com>
Copilot AI review requested due to automatic review settings April 3, 2026 04:28
@ammaarrahmed ammaarrahmed requested a review from azeey as a code owner April 3, 2026 04:28
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a new Jetty documentation page that guides users through practical steps to improve simulation performance / real-time factor, and exposes it through the tutorials landing page and sidebar.

Changes:

  • Added a new jetty/performance_tuning.md performance tuning guide.
  • Linked the new guide from jetty/tutorials.md.
  • Registered the new page in the Jetty docs sidebar via jetty/index.yaml.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
jetty/tutorials.md Adds a “Performance tuning” entry under Basics tutorials.
jetty/performance_tuning.md New tutorial page describing measurement and common tuning knobs, plus links to advanced/external options.
jetty/index.yaml Adds the new page to the tutorials section so it appears in the docs sidebar.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread jetty/performance_tuning.md Outdated
Comment thread jetty/performance_tuning.md Outdated
Comment thread jetty/tutorials.md Outdated
ammaarrahmed and others added 3 commits April 3, 2026 05:36
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Ammaar Ahmed <ammaarlatif53@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Ammaar Ahmed <ammaarlatif53@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Ammaar Ahmed <ammaarlatif53@gmail.com>
@ammaarrahmed
Copy link
Copy Markdown
Author

Hey @azeey , sorry to nudge , I would really appreciate some feedback on this PR and what could I further do to get this merged , please let me know, thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Inbox

Development

Successfully merging this pull request may close these issues.

3 participants