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

Broken links #41

Closed
martin-t opened this issue Jul 23, 2022 · 5 comments · Fixed by #122
Closed

Broken links #41

martin-t opened this issue Jul 23, 2022 · 5 comments · Fixed by #122
Labels
bug Something isn't working D-Medium Medium difficulty P-High High Priority S-not-started Work has not started on it

Comments

@martin-t
Copy link

The docs contain broken links - examples:

Note these are just 2 examples i ran into, there's probably more (especially since both seem to have the same cause - the relative links should go up first).

Both return 404 so it should be possible to write a periodic CI action to check all links on the website and detect this automatically.

@regzon
Copy link

regzon commented Aug 28, 2022

I've found out that the problem is related to the way links are generated.

When you open a documentation page, it adds a trailing slash to the URL. This trailing slash makes relative links broken.

But when you navigate through the documentation via the left panel, it doesn't add trailing slashes, and relative links work fine.

@filtoid
Copy link

filtoid commented Mar 22, 2023

I have found one on this page:
https://rapier.rs/docs/user_guides/bevy_plugin/advanced_collision_detection/#collision-and-contact-force-events

When linking out to advanced_collision_detection#collision-and-contact-force-events it adds an extra folder and becomes this:
https://rapier.rs/docs/user_guides/bevy_plugin/colliders/advanced_collision_detection#collision-and-contact-force-events

When it should be this:
https://rapier.rs/docs/user_guides/bevy_plugin/advanced_collision_detection/#collision-and-contact-force-events

I was going to submit a PR to add the leading slash but actually I think that would simply make the link relative to the root domain, which would also be wrong - not sure if there is a syntax to make it go up one dir first.

@Vrixyz Vrixyz added documentation Improvements or additions to documentation S-not-started Work has not started on it bug Something isn't working P-High High Priority D-Medium Medium difficulty and removed documentation Improvements or additions to documentation labels May 21, 2024
@gavinmorrow
Copy link

It happens to all the links in the user guides as far as I can tell (not including the sidebar).

@gavinmorrow
Copy link

I think it could probably be fixed if all the links had ../ prepended to them. (So rigid_bodies#mass-properties../rigid_bodies#mass-properties).

I was going to try this and then make a pull request but I can't even get the site to build on my computer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working D-Medium Medium difficulty P-High High Priority S-not-started Work has not started on it
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants