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.

Sign up for GitHub

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

Jump to bottom

Finalise notification banner macro options documentation #1997

Closed
3 tasks done
hannalaakso opened this issue Oct 27, 2020 · 0 comments · Fixed by #2024
Closed
3 tasks done

Finalise notification banner macro options documentation #1997

hannalaakso opened this issue Oct 27, 2020 · 0 comments · Fixed by #2024
Assignees
@hannalaakso @EoinShaughnessy
Labels
documentation User requests new documentation or improvements to existing documentation notification banner
Milestone
v3.10.0

Comments

@hannalaakso
Copy link
Member

hannalaakso commented Oct 27, 2020 •
edited by 36degrees
Loading

What

As part of #1935, our docs need explain what options the notification banner macro requires and how the macro can be configured to set a type, attributes etc.

Why

This component is particularly complicated when it comes to the API and the different things it can be configured to do so. Our users should be able to understand what the different macro options are and what their impact is from reading the docs.

Who needs to know about this

Owen, developers

Done when

  • Draft doc for macro options docs created
  • Content 2id if necessary
  • PR raised with new docs content
@hannalaakso hannalaakso added documentation User requests new documentation or improvements to existing documentation notification banner labels Oct 27, 2020
@hannalaakso hannalaakso mentioned this issue Oct 27, 2020
Closed
13 tasks
@hannalaakso hannalaakso self-assigned this Oct 29, 2020
@hannalaakso hannalaakso mentioned this issue Nov 4, 2020
Closed
@36degrees 36degrees added this to the v3.10.0 milestone Nov 13, 2020
@36degrees 36degrees linked a pull request Nov 19, 2020 that will close this issue
Update param descriptions for notification banner #2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hannalaakso hannalaakso

@EoinShaughnessy EoinShaughnessy

Labels
documentation User requests new documentation or improvements to existing documentation notification banner
Projects
GOV.UK Design System cycle board
Archived in project
Milestone
v3.10.0
Development

Successfully merging a pull request may close this issue.

Update param descriptions for notification banner alphagov/govuk-frontend
3 participants
@36degrees @hannalaakso @EoinShaughnessy