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

Automatically generate API reference in Frontend docs #5227

Open
1 task
Tracked by #5205
romaricpascal opened this issue Aug 9, 2024 · 1 comment
Open
1 task
Tracked by #5205

Automatically generate API reference in Frontend docs #5227

romaricpascal opened this issue Aug 9, 2024 · 1 comment
Labels
documentation User requests new documentation or improvements to existing documentation epic Epics are used in planning project boards to group related stories javascript

Comments

@romaricpascal
Copy link
Member

romaricpascal commented Aug 9, 2024

What

Warning

This needs breaking down a little more

Based on the spike in #5157, implement the automatic generation of an API reference in the Frontend docs.

Why

So we don't have to manually maintain the API reference, which can be generated from our JSDoc annotations

Who needs to work on this

Developers, Technical writers/Content designer (for the rendering in JSDoc)

Who needs to review this

Developers

Done when

  • The Frontend Docs display an API reference automatically generated from our JSDoc annotations
@romaricpascal romaricpascal changed the title Finish spike for generating an API reference automatically Automatically generate API reference Aug 9, 2024
@romaricpascal romaricpascal changed the title Automatically generate API reference Automatically generate API reference in Frontend docs Aug 9, 2024
@romaricpascal romaricpascal added documentation User requests new documentation or improvements to existing documentation javascript labels Aug 9, 2024
@romaricpascal romaricpascal added the epic Epics are used in planning project boards to group related stories label Aug 27, 2024
@romaricpascal
Copy link
Member Author

Due to the amount of linking between pieces of documentation in the JavaScript API reference (eg. the type of a function param linking to another class in the docs), we'll likely need a whole cycle of work to figure how to in so we'll leave it out of #5205.

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 epic Epics are used in planning project boards to group related stories javascript
Projects
Status: Backlog 🏃🏼‍♀️
Development

No branches or pull requests

1 participant