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

docs(ui): Improved accessibility #3072

Merged
merged 27 commits into from
Apr 9, 2024

Conversation

alt-shreya
Copy link
Contributor

@alt-shreya alt-shreya commented Mar 7, 2024

Description

  • Improved color contrast ratio.
  • Added discernible links and alt text for screen readers.
  • Fixed broken links and redirected deprecated repos.

Checklist

  • I have followed the Contributor Guide when preparing my PR.
  • I have updated/added tests for ALL new/updated/fixed functionality.
  • I have updated/added relevant documentation in docs and added dartdoc comments with ///.
  • I have updated/added relevant examples in examples or docs.

Breaking Change?

  • Yes, this PR is a breaking change.
  • No, this PR is not a breaking change.

Related Issues

Closes #2895

@alt-shreya alt-shreya changed the title docs(ui): improved accessibility docs(ui): Improved accessibility Mar 7, 2024
@spydon
Copy link
Member

spydon commented Mar 7, 2024

Awesome that you're working on this! Please add some screenshots with how it looks before and after the change.

@alt-shreya
Copy link
Contributor Author

Awesome that you're working on this! Please add some screenshots with how it looks before and after the change.

sure thing!

@immadisairaj immadisairaj mentioned this pull request Mar 29, 2024
3 tasks
@spydon
Copy link
Member

spydon commented Apr 1, 2024

@alt-shreya did you want any input here before continuing?

@alt-shreya
Copy link
Contributor Author

@alt-shreya did you want any input here before continuing?

@spydon no, my apologies for the delay, I had to prioritise a project for another client.
I'll pick this up now!

@alt-shreya
Copy link
Contributor Author

alt-shreya commented Apr 9, 2024

Awesome that you're working on this! Please add some screenshots with how it looks before and after the change.

@spydon Adding some screenshots as requested:

Before

Screenshot from 2024-04-09 11-10-27
Screenshot from 2024-04-09 11-10-55
Screenshot from 2024-04-09 11-11-57
Screenshot from 2024-04-09 11-12-13

Screenshot from 2024-04-09 12-37-19
Screenshot from 2024-04-09 11-22-01
Screenshot from 2024-04-09 11-12-36

After

Screenshot from 2024-04-09 11-17-52
Screenshot from 2024-04-09 14-35-45
Screenshot from 2024-04-09 16-34-39
Screenshot from 2024-04-09 16-52-46

@alt-shreya alt-shreya marked this pull request as ready for review April 9, 2024 11:51
@alt-shreya
Copy link
Contributor Author

@spydon there seems to be a conflict with markdown-lint tests. I have to include long URLs that are greater than 100 characters, but I don't seem to be able to wrap them like normal text. Should I just ignore the failures of the MD013 tests?

@spydon
Copy link
Member

spydon commented Apr 9, 2024

@spydon there seems to be a conflict with markdown-lint tests. I have to include long URLs that are greater than 100 characters, but I don't seem to be able to wrap them like normal text. Should I just ignore the failures of the MD013 tests?

You can just move them to the next line in the markdown file, they will still render as continues text as long as you don't do two line breaks.

@alt-shreya
Copy link
Contributor Author

You can just move them to the next line in the markdown file, they will still render as continues text as long as you don't do two line breaks.

I've tried this, but it raises another error: MD034 no-bare-URL

@alt-shreya
Copy link
Contributor Author

You can just move them to the next line in the markdown file, they will still render as continues text as long as you don't do two line breaks.

I've tried this, but it raises another error: MD034 no-bare-URL

All tests seem to be passing now 🤔

Copy link
Member

@spydon spydon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm! Thanks for your contribution

@spydon spydon merged commit a4a6a6a into flame-engine:main Apr 9, 2024
8 checks passed
@alt-shreya
Copy link
Contributor Author

Lgtm! Thanks for your contribution

Lessgoo! Looking forward to contributing more in the future! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation Improvements
2 participants