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

Update internal docs on configuration options #5501

Open
1 task
Tracked by #5373
romaricpascal opened this issue Nov 15, 2024 · 1 comment · May be fixed by #5516
Open
1 task
Tracked by #5373

Update internal docs on configuration options #5501

romaricpascal opened this issue Nov 15, 2024 · 1 comment · May be fixed by #5516
Assignees
Labels
documentation User requests new documentation or improvements to existing documentation

Comments

@romaricpascal
Copy link
Member

romaricpascal commented Nov 15, 2024

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

  • The 'Component options' docs are up to date
@romaricpascal romaricpascal added the documentation User requests new documentation or improvements to existing documentation label Nov 15, 2024
@romaricpascal romaricpascal moved this to Backlog 🏃🏼‍♀️ in GOV.UK Design System cycle board Nov 15, 2024
@Izabela-16 Izabela-16 moved this from Backlog 🏃🏼‍♀️ to In progress 📝 in GOV.UK Design System cycle board Nov 18, 2024
@domoscargin
Copy link
Contributor

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.

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
Projects
Status: In progress 📝
Development

Successfully merging a pull request may close this issue.

2 participants