Collect examples of good JavaScript API documentations

alphagov / govuk-frontend

GOV.UK Frontend contains the code you need to start building a user interface for government platforms and services.

https://frontend.design-system.service.gov.uk/

MIT License

1.17k stars 320 forks source link

Closed romaricpascal closed 1 month ago

romaricpascal commented 2 months ago

Collect examples of JavaScript API documentations we find good and what we think they do well.

This can help us shape our own API documentation by replicating good practices others are already doing

Developers

Tech writer, Developers

[ ] We have a list of JavaScript API documentation examples and what we think they do well.

romaricpascal commented 1 month ago

Examples have been reviewed and we've gathered a list of useful features (internal link)