docs(type): update link to type styles in README #5058
Conversation
packages/type/README.md
Outdated
| @@ -85,7 +85,7 @@ what we call type styles. These tokens have a variety of properties for styling | |||
| how text is rendered on a page. | |||
|
|
|||
| You can find a full reference of the type styles that are available | |||
| [here](https://next.carbondesignsystem.com/guidelines/typography/productive) . | |||
| [Carbon Design System website](https://www.carbondesignsystem.com/guidelines/typography/productive) . | |||
There was a problem hiding this comment.
Should we update the sentence? Could you explain more about the accessibility shortcoming?
There was a problem hiding this comment.
Oh I mean to update the sentence completely, to avoid having link text that just says "here"
There was a problem hiding this comment.
Oh sorry just noticed your edit --
Here's two quick resources I found to explain this:
In addition to the reasons about context provided in those links, if you are using a screenreader + tabbing between focusable elements you may just hear "Link Here" or "Link Click here" which isn't helpful.
|
Deploy preview for the-carbon-components ready! Built with commit 5607773 https://deploy-preview-5058--the-carbon-components.netlify.com |
|
Deploy preview for carbon-elements ready! Built with commit 5607773 |
|
Deploy preview for carbon-elements failed. Built with commit 19dc544 https://app.netlify.com/sites/carbon-elements/deploys/5e22047195add0000950d5ff |
|
Deploy preview for carbon-components-react ready! Built with commit 19dc544 https://deploy-preview-5058--carbon-components-react.netlify.com |
|
Deploy preview for the-carbon-components ready! Built with commit 19dc544 https://deploy-preview-5058--the-carbon-components.netlify.com |
|
@joshblack Just in case you have further comments - Thanks! |
…m#5058) * docs(type): update link to type styles in README * docs(type): update README text for context * chore: format type package README doc Co-authored-by: emyarod <[email protected]> Co-authored-by: Josh Black <[email protected]>
Currently this link to color tokens on the
@carbon/typeREADME just leads to the homepage, due to the deprecated next subdomain.Also the use of "here" as link text is not very accessible, as someone using a screenreader who skips to the link won't have info in the link text about where the link goes.
Changelog
Changed