You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In #2563 we decided where and how we would document our public JavaScript API for users. This card covers actually writing that documentation and publishing it on the platform/pages we agreed.
Why
So users are informed about what JavaScript methods are available to them, when they might need to use them and why.
We should make sure this information is easily discoverable rather than relying on users digging into our code on Github to find out more.
Who needs to work on this
Tech Writer; Developer
Who needs to review this
Developers
Done when
Audit our component JavaScript to decide what needs documenting for each component
What
In #2563 we decided where and how we would document our public JavaScript API for users. This card covers actually writing that documentation and publishing it on the platform/pages we agreed.
Why
So users are informed about what JavaScript methods are available to them, when they might need to use them and why.
We should make sure this information is easily discoverable rather than relying on users digging into our code on Github to find out more.
Who needs to work on this
Tech Writer; Developer
Who needs to review this
Developers
Done when
The text was updated successfully, but these errors were encountered: