Closed Bug 1283523 Opened 5 years ago Closed 4 years ago

document what the devtools loader provides

Categories

(DevTools :: General, enhancement, P3)

enhancement

Tracking

(Not tracked)

RESOLVED INVALID

People

(Reporter: tromey, Assigned: tromey)

Details

Attachments

(1 file)

Bug 1266844 pointed out that we should document what the loader provides,
particularly as we're moving to a more content-like environment.
I wasn't sure what to write here other than a list of available APIs, so that's what I've done.
I'm open to suggestions.
Severity: normal → enhancement
Component: Developer Tools: Framework → Developer Tools
https://reviewboard.mozilla.org/r/61626/#review60382

::: devtools/docs/SUMMARY.md:10
(Diff revision 1)
>    * [Inspector](inspector-panel.md)
>    * [Memory](memory-panel.md)
>    * [Debugger](debugger-panel.md)
>    * [Responsive Design Mode](responsive-design-mode.md)
>  * [Frontend](frontend.md)
> +  * [Environment](environment.md)

I'd rather this be renamed to something that explicitly describes the "older" environment of using the Chrome loader. We don't really want to encourage that anymore. From now own, we should just use BrowserLoader and modules are automatically evaluated in a content environment.

We're making the Chrome loader more compatible because we have a lot of existing code, and probably more importantly, so that we can share modules between frontend and backend.

What about creating a new top-level section called something like "Notes" and creating a "Loaders" section under it? I feel like there could be several sections there that describe knowledge that we all have in our head. The "Loaders" section should explain the above, that we currently have code that shared modules across frontend/backend and thus need these APIs for compat, but new code should also use the BrowserLoader.
Comment on attachment 8766906 [details]
Bug 1283523 - document bindings available to devtools clients;

https://reviewboard.mozilla.org/r/61626/#review63012

Removing my review flag as I already reviewed it. Let me know if you want to talk about this more.
Attachment #8766906 - Flags: review?(jlong)
I don't think this is relevant any more.
Docs have moved to github and been redone.
Status: ASSIGNED → RESOLVED
Closed: 4 years ago
Resolution: --- → INVALID
Product: Firefox → DevTools
You need to log in before you can comment on or make changes to this bug.