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

Give alt text to Bevy logo #13205

Merged
merged 1 commit into from
May 3, 2024
Merged

Give alt text to Bevy logo #13205

merged 1 commit into from
May 3, 2024

Conversation

BD103
Copy link
Member

@BD103 BD103 commented May 3, 2024

Objective

  • In the documentation of the bevy crate, we embed the Bevy logo. (docs.rs, logo)
  • It was first added in 9aae341.
  • Markdown supports adding alternate descriptions for images that either cannot be loaded or for screen readers.

Solution

  • Add alt text for the Bevy logo.

Changelog

  • Added alt text to Bevy logo.

@BD103 BD103 added C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy X-Uncontroversial This work is generally agreed upon labels May 3, 2024
@BD103
Copy link
Member Author

BD103 commented May 3, 2024

I'm unsure whether this gets the A-Cross-Cutting or A-Core labels, so 🤷‍♂️.

I think the only downside to this change is that now, if the logo ever fails to load, there will be some text in its place instead of it just being empty.

image

This could affect the shortened docs if the bevy crate is ever re-exported. I need to test this.

@BD103
Copy link
Member Author

BD103 commented May 3, 2024

This could affect the shortened docs if the bevy crate is ever re-exported. I need to test this.

rustdoc just ends up not giving pub use bevy; a short description in the generated output. I think this is because there is an image tag as the very first line, and unrelated to my change.

@BD103 BD103 added the D-Domain-Agnostic Can be tackled by anyone with generic programming or Rust skills label May 3, 2024
@pablo-lua pablo-lua added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label May 3, 2024
Copy link
Contributor

@TimJentzsch TimJentzsch left a comment

Choose a reason for hiding this comment

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

Yay for accessibility!

@alice-i-cecile alice-i-cecile added this pull request to the merge queue May 3, 2024
Merged via the queue into bevyengine:main with commit c3eb3a1 May 3, 2024
33 checks passed
@BD103 BD103 deleted the logo-alt branch May 3, 2024 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-Docs An addition or correction to our documentation D-Domain-Agnostic Can be tackled by anyone with generic programming or Rust skills D-Trivial Nice and easy! A great choice to get started with Bevy S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it X-Uncontroversial This work is generally agreed upon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants