1749795 - Create documentation for adding and testing site-specific wrappers

Status: RESOLVED FIXED

(Toolkit :: Picture-in-Picture, task, P3)

Description

[Micah [:mtigley] (she/her)]

We'll be establishing infrastructure for adding site-specific wrapper scripts in bug 1670108. While we do have some inline JS documentation for this, we should still have something that gives a high-level overview on:

1. Why these site-specific wrapper scripts are needed in the first place
2. How they work (loading a wrapper script from the PiP system addon and loading it into a sandbox environment from PiP child...)
3. How to add a new wrapper script
4. Adding/modifying tests for these scripts

We should first keep these docs under the toolkit/components/pictureinpicture/docs/ directory and create a sub-page for them under the Picture-in-Picture section

Comment 1

[Ania]

Let's also include adding a brief how-to for contributors on how to add test-specific wrappers as a part of this scope.

Comment 2

[kpatenio]

I recently started a draft document for site-specific wrappers, so I will be assigning myself to this ticket. Goal is to get all documentation on Firefox Source Docs

Comment 3

[kpatenio]

Attachment: Bug 1749795 - create documentation for adding and testing site-specific wrappers. r=#pip-reviewers!

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/e384ba8874fb
create documentation for adding and testing site-specific wrappers. r=mhowell

Comment 5

[Natalia Csoregi [:nataliaCs]]

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