Skip to content

Conversation

@1ace
Copy link

@1ace 1ace commented Nov 26, 2025

Objective

Fix documentation links in examples (2d_shapes & 3d_shapes).

Solution

The two links currently render as plain text (see links above); changing [label][target] to [label](target) seems like the right fix as this is the format used for links elsewhere, but I haven't figured out how to render them locally to verify.

Testing

Not tested; I haven't figured out how to render these locally, but at worst this will be a no-op change so let's see 😅

@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 ✨

@dloukadakis
Copy link
Contributor

It seems the website is not handling rustdoc links properly. [][] is already valid rustdoc syntax for links.

We should probably consider rewriting these with compatibility with the website in mind or improve the website so it handles rustdoc links to some extent.

@dloukadakis dloukadakis added C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy S-Nominated-To-Close A triage team member thinks this PR or issue should be closed out. labels Nov 28, 2025
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-Trivial Nice and easy! A great choice to get started with Bevy S-Nominated-To-Close A triage team member thinks this PR or issue should be closed out.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants