firefox-devtools / firefox-devtools/profiler

[End User Docs] Spec

Open
#805 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
TypeScript
Stars
1.5k
Forks
491
Avg merge
3d 5h
Merged PRs (30d)
30

Description

We should have really nice end user documentation.

### Profiler - how it works
* [x] Probabilistic samples
* [x] Deterministic markers

### Header
* [ ] What are threads
* [ ] Main/content threads
* [ ] ThreadStack graph
* [ ] Markers
* [ ] Thread responsiveness

### Workflows
* [ ] Profile sharing
* [ ] How to file a perf bug
* [ ] Gecko profiler add-on
* [ ] Mobile profiling

### Call tree
* [x] Summarizes information
* [x] How it is generated
* [x] What is a Call Node?
* [x] Inverting
* [x] Filtering implementation
* [ ] Call tree transforms
* [x] Searching
* [ ] Workflows

## Stack chart
* [ ] Lays out information over time.

### Marker chart
* [ ] Explain markers
* [ ] Known markers documentation
* [ ] How to add markers
* [ ] UserTimings

### Other types of documentation
* [ ] Document workflows
* [x] Integrate [video documentation](https://www.youtube.com/watch?v=MxgWOTqxOTg&list=PLxaZqnd-OQM620EZ_6eT8qurOnZ4eu6dz)

### Understanding performance
* [ ] Provide recommended reading links
* [ ] Big O and complexity
https://www.desmos.com/calculator/dlh7cpeav1
https://rob-bell.net/2009/06/a-beginners-guide-to-big-o-notation/
* [ ] Optimize only things that are slow
* [ ] How to find slow code
* [ ] How to fix slow code
* [ ] JS: Fixing GC issues
* [ ] C++: Code locality
* [ ] Lazy loading, only compute what is shown
* [ ] Caching: Don't re-compute

┆Issue is synchronized with this [Jira Task](https://mozilla-hub.atlassian.net/browse/FP-703)

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.