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 Design System site content for v5 changes #2993

Closed
15 of 16 tasks
Tracked by #2186
claireashworth opened this issue Aug 1, 2023 · 0 comments · Fixed by #3344
Closed
15 of 16 tasks
Tracked by #2186

Update Design System site content for v5 changes #2993

claireashworth opened this issue Aug 1, 2023 · 0 comments · Fixed by #3344
Assignees
Labels
documentation User requests new documentation or improvements to existing documentation
Milestone

Comments

@claireashworth
Copy link
Contributor

claireashworth commented Aug 1, 2023

What

Define and update the Design System site's content with changes for v.5.0.0.

Why

v5.0.0 might need explicit documentation to differentiate it from v4.0.0.

Who needs to work on this and review it

Tech writer, content designer, developers, designers

Done when

The content is agreed and drafted ready for testing with users and reviewing.

  • Make changes to 'Get started' page
  • Make changes to 'Styles>colours'
  • Make changes to 'Styles>page template'
  • Make changes to 'Header component'
  • Review complete
  • Publishing complete

Get started

  • Update or remove sentence on legacy products
  • possibly update for sentences in Production > Option 1: install using npm > bullet points 2 and 3 referring to typography, mixins and overriding colours etc
  • as above but for Option 2
  • once frontend site has agreed changes, make sure links from DS to FE are going to the correct area
  • Suggest we remove 'Replace variables, functions and mixins from our old frameworks' for v5 and keep them for v4 only with the frontend docs.

Styles > colours

  • do we want to keep the mentions of WCAG 2.1 for v4 documentation? This might have been decided elsewhere already.

Styles > Page template

Header component

@claireashworth claireashworth added the awaiting triage Needs triaging by team label Aug 1, 2023
@claireashworth claireashworth added documentation User requests new documentation or improvements to existing documentation and removed awaiting triage Needs triaging by team labels Aug 1, 2023
@claireashworth claireashworth added this to the v5.0 milestone Aug 1, 2023
@calvin-lau-sig7 calvin-lau-sig7 linked a pull request Dec 1, 2023 that will close this issue
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
Development

Successfully merging a pull request may close this issue.

2 participants