TBD54566975 / open-source-playbook

TBD's Ethos and Practices behind our Open Source Business
Apache License 2.0
1 stars 2 forks source link

Define remit for API Docs #18

Closed ALRubinger closed 1 year ago

ALRubinger commented 1 year ago

Deliverable: a template from DevRel providing guidance on info needed by OSE in the request.

OSE to provide an example, @frankhinek notes that TypeScript helps with lot of this. And it'll have to be iterative; ask OSE and well evolve the handoff process as we go.

General outline:

Some of these may be implicit in a statically-typed language.

For instance from: https://developer.mozilla.org/en-US/docs/Web/API/Clipboard

image

DevRel is primary remit for delivery, including prose like:

image