-
Notifications
You must be signed in to change notification settings - Fork 5
Improve accessibility of traffic lights: replacing 🟢🟠🔴 with JustTheDoc's labels. #531
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copilot reviewed 17 out of 17 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (1)
docs/pages/templates.md:41
- There is a typo in the description ('templae'). Please correct it to 'template'.
| [Copier](https://github.com/copier-org/copier) | A tool to create project templates that are highly configurable. Project configuration can be kept in sync with the templae. | <span class="label label-yellow">Good</span> |
Feels like it's a change warranting two reviewers. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks like a really nice change 👌
Co-authored-by: Patrick J. Roddy <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great - thanks @samcunliffe ! I just noticed a couple of places where the label had been changed - see below:
😱 I did a find-and-replace. How... 🫠 !? |
for more information, see https://pre-commit.ci
How did you perform this? I've never missed anything in an IDE, but have seen others miss them using |
No, it was the VSCode cmd+F. And it takes emoji as a searchable string. I think it must have been leftover from my experiments and I didn't |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @samcunliffe - all looks good now!
An attempt to solve
by replacing the emoji (same shape different colours) with a JustTheDocs label UI component.
Unfortunately, the JTD-flavoured markdown syntax for this is
... that is to say: it needs two lines. And obviously, this doesn't work inside markdown tables.
But once upon a time, I learned some HTML 🙃 so we can also access them as
tags.
Now! This makes the markdown not look as beautiful/colourful/emojiful when viewed in GitHub...
(though arguably more readable... which is perhaps the accessibility point.)
Here's what it looks like on the built pages: