search

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.19k stars 327 forks source link

Update internal docs on configuration options #5501

Open romaricpascal opened 1 week ago

romaricpascal commented 1 week ago

What

Update the repositories' docs about component options to reflect the addition of the ConfigurableComponent. We may be able to point to the Frontend Docs for some of it (however, the part about Nunjucks options is not described in the new 'Building configurable components' section).

Why

So our internal docs are up to date with the code

Who needs to work on this

Developers, Tech writers

Who needs to review this

Developers, Tech writers

Done when

domoscargin commented 5 days ago

While working on this, it strikes me there's some suboptimal overlap between our repo dev docs, and the Frontend Docs site.

It's a bit unclear to me which bits should ideally go where. I personally lean to moving ALL documentation to the site.

I'll make the changes for this PR, but probably something to circle back round to at some point.