bevy-website icon indicating copy to clipboard operation
bevy-website copied to clipboard

Example docs can be misinterpreted as HTML causing formatting issues

Open it-me-joda opened this issue 2 months ago • 1 comments

Describe the issue

Examples where docs include things that look like HTML tags causes issues.

https://bevy.org/examples/3d-rendering/3d-shapes/ Assets<A> in the rust docs is read as an opening <a> tag and renders the entire rest of the page as a link.

Proposed Solution

The docs for the example needs to have special characters properly escaped, the docs need to be displayed without processsing as HTML, or both.

it-me-joda avatar Nov 11 '25 17:11 it-me-joda

I was able to set up a simple local Zola project and reproduce this behavior, and we should be able to resolve it by just wrapping the offending Assets<A> as a code snippet similar to the other examples in this file.

I'm glad to look into this instance, ~~but I'm not sure if it's possible to stand up the whole website locally for testing purposes, since the examples lives in the Bevy engine repo and will need to be resolved over there.~~

Rodhlann avatar Nov 13 '25 01:11 Rodhlann