Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish documentation for our component JavaScript API #2564

Closed
6 tasks
Tracked by #1389
vanitabarrett opened this issue Mar 1, 2022 · 1 comment
Closed
6 tasks
Tracked by #1389

Publish documentation for our component JavaScript API #2564

vanitabarrett opened this issue Mar 1, 2022 · 1 comment
Assignees
Labels
documentation User requests new documentation or improvements to existing documentation javascript

Comments

@vanitabarrett
Copy link
Contributor

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

  • Audit our component JavaScript to decide what needs documenting for each component
  • Draft documentation
  • Draft is reviewed by tech writer and developers
  • PR is raised to add documentation to the agreed place
  • Decide if we want to do any research with the documentation before publishing it?
  • Published
@vanitabarrett vanitabarrett added documentation User requests new documentation or improvements to existing documentation javascript labels Mar 1, 2022
@claireashworth claireashworth self-assigned this Oct 25, 2022
@36degrees
Copy link
Contributor

Closing as we're now publishing our JavaScript API Reference as part of the frontend docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation User requests new documentation or improvements to existing documentation javascript
Projects
None yet
Development

No branches or pull requests

3 participants