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

Improve Links section of SASS API reference #113

Closed
EoinShaughnessy opened this issue Apr 20, 2021 · 2 comments
Closed

Improve Links section of SASS API reference #113

EoinShaughnessy opened this issue Apr 20, 2021 · 2 comments
Assignees
@EoinShaughnessy
Labels
documentation Improvements or additions to documentation Effort: days Used by the team when triaging

Comments

@EoinShaughnessy
Copy link
Contributor

EoinShaughnessy commented Apr 20, 2021 •
edited
Loading

Related documentation

SASS API reference | Links

Suggestion

  • Provide explanatory text about how this section helps users
  • Display subsections in a more logical order
  • Make presentation of content more consistent
  • Improve navigability (for example, by inserting a table of contents)

Evidence

#23 lists SASS API reference as a content area we should improve. So does this doc on improving Design System/Frontend content.

Also, now that we're adding new mixins (see alphagov/govuk-frontend#2183), it seems like a good time to make the Links section more user-friendly.
@EoinShaughnessy EoinShaughnessy added documentation Improvements or additions to documentation Effort: days Used by the team when triaging awaiting triage Needs triaging by team labels Apr 20, 2021
@EoinShaughnessy EoinShaughnessy self-assigned this Apr 20, 2021
@EoinShaughnessy EoinShaughnessy removed the awaiting triage Needs triaging by team label Apr 20, 2021
@EoinShaughnessy EoinShaughnessy added this to In progress 📝 in Design System Sprint Board Apr 20, 2021
@EoinShaughnessy
Copy link
Contributor Author

Review doc: https://docs.google.com/document/d/1ZdNSHZmsUsnyPiINH1tSggplvPnhQh5C7auLc1qdVQM/edit#

@EoinShaughnessy
Copy link
Contributor Author

Closing this as it's been superseded by #114, #115, #116 and #117.

@kellylee-gds kellylee-gds removed this from In progress 📝 in Design System Sprint Board Apr 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@EoinShaughnessy EoinShaughnessy

Labels
documentation Improvements or additions to documentation Effort: days Used by the team when triaging
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@EoinShaughnessy