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

IconTile documentation update #2514

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

andgen404
Copy link
Contributor

@andgen404 andgen404 commented Oct 21, 2024

An accessibility audit of the HVS application revealed confusion between interactive elements (like buttons) and non-interactive Icon Tiles. To address this, it is recommended that the Icon Tile documentation be updated with guidance on ensuring clear visual distinction and avoiding placement of Icon Tiles near buttons or other interactive elements.

📌 Summary

If merged, this PR will update IconTile documentation with guidance on avoiding placement near interactive elements to improve distinguishability and accessibility.

Link to Documentation ---------> https://hds-website-git-icontile-documentation-update-hashicorp.vercel.app/components/icon-tile#near-interactive-elements

📸 Screenshots

CleanShot 2024-07-24 at 18 56 26-20240724-235701

🔗 External links

Jira ticket: HDS-3586


Updated guidelines around better usability when other interactive elements like the secondary button is near.
Copy link

vercel bot commented Oct 21, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview Oct 22, 2024 0:10am
hds-website ✅ Ready (Inspect) Visit Preview Oct 22, 2024 0:10am

@hashibot-hds hashibot-hds added the docs-website Content updates to the documentation website label Oct 21, 2024
Copy link
Contributor

@majedelass majedelass left a comment

Choose a reason for hiding this comment

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

This is great, just had two notes. Feel free to word smith the first suggestion if you feel it's too wordy.

I think after we can open this up to the team.

@andgen404 andgen404 changed the title IconTile documentation update HDSIconTile documentation update Oct 21, 2024
@andgen404 andgen404 marked this pull request as ready for review October 21, 2024 19:54
@andgen404 andgen404 requested review from a team October 21, 2024 19:55
Copy link
Contributor

@jorytindall jorytindall left a comment

Choose a reason for hiding this comment

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

One small note, probably brings up some larger questions though. I'll also through out that the example used is also referenced in the Table content documentation. Not necessarily a problem, just noting the overlap, or maybe there's another example that could be used?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-website Content updates to the documentation website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants