Write/import Base & Gecko Profiler in-tree documentation for firefox-source-docs.mozilla.org
Categories
(Core :: Gecko Profiler, task, P3)
Tracking
()
People
(Reporter: mozbugz, Unassigned)
References
Details
There is some documentation on https://profiler.firefox.com/docs/ , but it's mostly targeted at users of the Profiler (how to capture profiles, and how to understand them).
It would be good to have developer-oriented documentation for the most important profiler APIs, e.g.: How to programmatically control the profiler (for tests), add labels, markers, and counters, etc.
See "Adding Documentation" at the bottom of https://firefox-source-docs.mozilla.org/index.html
|
||
Comment 1•6 years ago
|
||
We also have front-end developer docs: https://github.com/firefox-devtools/profiler/tree/master/docs-developer
It would be nice if the Gecko Profiler docs would by co-located in tree though. Perhaps some of the front-end developer docs would need to move over to the Gecko side as well.
|
Reporter | |
Comment 2•4 years ago
|
||
We have docs! https://firefox-source-docs.mozilla.org/tools/profiler/index.html
This started in bug 1641000 (thanks Greg!).
So I'm marking this bug here fixed. Future improvements should have their own bugs.
Description
•