Skip to content

Conversation

@Rodhlann
Copy link
Contributor

@Rodhlann Rodhlann commented Nov 14, 2025

Objective

Resolve formatting issue in 3D Shapes Example page on the Bevy Website, where an unwrapped Assets<A> is breaking the HTML rendering on the page. This fix follows the standard set forth by other Assets<A> instances on the page.

Fixes bevy-website issue: bevyengine/bevy-website#2302

Solution

Wrap Assets<A> as a code snippet to resolve HTML rendering issues. Wrapping the code properly encodes the characters so they are not interpreted as an HTML <a> tag.

Testing

I am still working on setting up the bevy-website locally to render the Bevy examples, so I have been unable to test this directly, but I have set up a Zola demo project in my local environment where I was able to reproduce and fix the behavior using the same strategy.

I have been able to render the examples locally with the fix, see examples below


Showcase

Issue In Live Site

image image

Issue Resolve In Local Site

image image

Issue Reproduced In Local Zola Project

image image

Issue Resolved In Local Zola Project

image image

@github-actions
Copy link
Contributor

Welcome, new contributor!

Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨

@mockersf
Copy link
Member

This would make the link invalid in docs

@Rodhlann
Copy link
Contributor Author

Rodhlann commented Nov 15, 2025

This would make the link invalid in docs

I'm not sure I understand, this wasn't intended to be a link in the docs, I don't think? There are several other instances in this same doc where we are using the same [Assets<A>::add] block, this was just the only one where the Assets<A>::add hadn't been wrapped as a code snippet, which was causing the <A> to be interpreted as HTML, causing the UI breakage.

@alice-i-cecile alice-i-cecile added D-Trivial Nice and easy! A great choice to get started with Bevy C-Examples An addition or correction to our examples S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it labels Nov 16, 2025
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Nov 16, 2025
Merged via the queue into bevyengine:main with commit a1c4943 Nov 16, 2025
42 checks passed
@Rodhlann Rodhlann deleted the 3d-shapes-doc-fix branch November 17, 2025 00:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C-Examples An addition or correction to our examples 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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants