1773035 - Add documentation for Custom Formatters

Status: RESOLVED FIXED

(DevTools :: Documentation, task)

Comment 1

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Firefox-source-docs has two sections for DevTools

• DevTools User Docs (mainly DevTools UI) https://firefox-source-docs.mozilla.org/devtools-user/index.html
• DevTools Contributor Docs (mainly DevTools source code) https://firefox-source-docs.mozilla.org/devtools/index.html

CustomFormatterss seem to belong to "Contributor Docs"
Perhaps we could create a new "Custom Formatters" page and link it from this page:
https://firefox-source-docs.mozilla.org/devtools/index.html#tool-architectures
(e.g. from the Frontend section)

The location of the new page (for Custom Formatters) could be e.g.
https://firefox-source-docs.mozilla.org/devtools/frontend/custom-formatters.html

Comment 2

[Nicolas Chevobbe [:nchevobbe]]

(In reply to Jan Honza Odvarko [:Honza] (always need-info? me) from comment #1)

CustomFormatterss seem to belong to "Contributor Docs"

When talking about this documentation, I was thinking more about a user-facing documentation, to explain how to enable and use custom formatters

Comment 3

[Sebastian Zartner [:sebo]]

I agree with Nicolas on this. The idea was to let users know about this feature.

Sebastian

Comment 4

[Jan Honza Odvarko [:Honza] (always need-info? me)]

I see, ok for me.

So, would this also contain examples of how to write CFs?
Or is the plan just point to others docs/posts?

Comment 5

[Sebastian Zartner [:sebo]]

Attachment: Bug 1773035 - Added documentation for custom formatters. r=nchevobbe,Honza

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/cff1be3e5fa0
Added documentation for custom formatters. r=nchevobbe,devtools-reviewers DONTBUILD

Comment 7

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/cff1be3e5fa0