Closed Bug 1260240 Opened 8 years ago Closed 7 years ago

Write an API overview page for WebExtensions

Categories

(Developer Documentation Graveyard :: Add-ons, defect)

defect
Not set
normal

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: wbamberg, Unassigned)

Details

We should have a page that gives an overview of the WebExtension JS APIs. It should explain how to access the APIs, give an idea of what APIs are available, and link to more detailed documentation.

Ideally it should give a summary of the support status for each API, but I think that should happen after the basic content is done.
I've written a page here: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API

The first part is about where you can access the APIs, namespaces, and a bit on promises.

The second part is a listing of all the APIs, with:

a) a short summary of the API, including a note about whether it needs a permission
b) a link to the reference docs

(a) is included using a macro from the preamble for each reference page (e.g. https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API#alarms is included from the start of https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/alarms).

I would like this to also include a little table summarizing the support status for the API, but there's more infrastructure needed for that.
Let me know if this works. Feel free to delegate if you would like.
Flags: needinfo?(kmaglione+bmo)
Status: NEW → RESOLVED
Closed: 7 years ago
Flags: needinfo?(kmaglione+bmo)
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.