govuk-frontend icon indicating copy to clipboard operation
govuk-frontend copied to clipboard

Automatically generate API reference in Frontend docs

Open romaricpascal opened this issue 1 year ago • 1 comments
trafficstars

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 avatar Aug 09 '24 14:08 romaricpascal

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.

romaricpascal avatar Aug 27 '24 10:08 romaricpascal