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

Encourage only including code for things that are being used #436

Closed
Tracked by #3731
36degrees opened this issue Apr 19, 2024 · 2 comments · Fixed by #442
Closed
Tracked by #3731

Encourage only including code for things that are being used #436

36degrees opened this issue Apr 19, 2024 · 2 comments · Fixed by #442
Assignees
@claireashworth
Labels
documentation Improvements or additions to documentation

Comments

@36degrees
Copy link
Contributor

36degrees commented Apr 19, 2024 •
edited by claireashworth
Loading

What

Amend the content in selected pages of the Frontend site to make the user installation journey clearer including only using the code you need.

How

Remove or move pages that are no longer needed in their current location
Update headings and content of remaining pages focusing on clarity and de-duplication of information

Who

Tech writer, Developers
@36degrees 36degrees mentioned this issue Apr 19, 2024
Closed
@36degrees 36degrees transferred this issue from alphagov/govuk-design-system Apr 19, 2024
@36degrees 36degrees changed the title Improve our documentation to nudge people towards optimising what they include Improve our docs to encourage only including the things that are being used Apr 19, 2024
@36degrees 36degrees changed the title Improve our docs to encourage only including the things that are being used Encourage only including code for things that are being used Apr 19, 2024
@36degrees 36degrees mentioned this issue Apr 19, 2024
Closed
2 tasks
@36degrees 36degrees moved this to Backlog 🏃🏼‍♀️ in GOV.UK Design System cycle board Apr 22, 2024
@claireashworth claireashworth moved this from Backlog 🏃🏼‍♀️ to In progress 📝 in GOV.UK Design System cycle board May 2, 2024
@claireashworth claireashworth self-assigned this May 2, 2024
@claireashworth claireashworth added the documentation Improvements or additions to documentation label May 2, 2024
@claireashworth
Copy link
Contributor

Proposal for changes written and shared with team for review.

@claireashworth
Copy link
Contributor

Team review complete. Drafting changes underway.

@claireashworth claireashworth linked a pull request May 8, 2024 that will close this issue
Update content to streamline installation info #442
Merged
@owenatgov owenatgov moved this from In progress 📝 to Needs review 🔍 in GOV.UK Design System cycle board May 8, 2024
@36degrees 36degrees moved this from Needs review 🔍 to Done 🏁 in GOV.UK Design System cycle board May 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@claireashworth claireashworth

Labels
documentation Improvements or additions to documentation
Projects
GOV.UK Design System cycle board
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update content to streamline installation info alphagov/govuk-frontend-docs
2 participants
@36degrees @claireashworth