Skip to content

Example docs can be misinterpreted as HTML causing formatting issues #2302

@it-me-joda

Description

@it-me-joda

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions