bevyengine / bevyengine/bevy

Improve documentation on how to setup and run Tracy

Open
#15,967 1 comment 2 reactions 0 assignees View on GitHub
A-Diagnostics C-Docs D-Straightforward S-Ready-For-Implementation
Dominant language
Rust
Stars
48.2k
Forks
4.8k
Avg merge
3d 22h
Merged PRs (30d)
161

Description

## How can Bevy's documentation be improved?

Bevy's documentation about how to setup and run Tracy could be improved. I am referring to this file: https://github.com/bevyengine/bevy/blob/main/docs/profiling.md

In my opinion it should have separated sections per platform and simply directly list the steps and commands needed to run Tracy, avoiding to disperse them within a pretty long paragraph.
For Windows, it also just links to Tracy's PDF documentation, which is extremely dense in information and very difficult to scan quickly to just find what you need to do to profile your Bevy application.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.