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

Beginner's guide to editing the docs - link not correct? #538

Open
DorusvdLinden opened this issue Oct 6, 2024 · 2 comments
Open

Beginner's guide to editing the docs - link not correct? #538

DorusvdLinden opened this issue Oct 6, 2024 · 2 comments

Comments

@DorusvdLinden
Copy link

DorusvdLinden commented Oct 6, 2024

I automatically always get the /latest/ added to the https://missionpinball.org/ link:
https://missionpinball.org/latest/

When clicking on the "Beginner's guide to editing the docs" link below any page it tries to go to:
missionpinball.org/about/help

which does not resolves into:
missionpinball.org/latest/about/help
but gives me an error 404 warning

I tried in both edge & chrome.

@worldpeace-germany
Copy link
Contributor

Hi,

I did a quick look at it, first of all I can reproduce the behavior. In case it helps, you can use this link

https://missionpinball.org/latest/about/help_docs/

to find how to edit doc pages.

Now the tricky part, when you edit the doc pages you run a server locally to test if everything works fine. (Running mkdocs serve). Usually you have for everything relative links so if the web page introduces a "latest" on the highest level doesn't matter too much. BUT: There are lots of includes for easier re-usage, for example for about/help, that is working perfectly fine with mkdocs serve , and these links are absolute links.

See here https://github.com/missionpinball/mpf-docs/blob/main/includes/content_footer.md

Easy fix for the latest web page, add the latest in this absolute link, but then of course it won't work for version specific links. Having a relative link here won't work either since you never know where the include is included.

I am not an expert on the mkdocs, so I am not able to propose a really smart solution. Just wanted to give a first analysis and some background.

@worldpeace-germany
Copy link
Contributor

Cross reference #488

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants