Skip to content

docs: Fix link in CMake readme #12529

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

MrOnlineCoder
Copy link
Contributor

Fixes deadlink to linux readme in cmake build docs

@slouken
Copy link
Collaborator

slouken commented Mar 12, 2025

I think this is actually an issue with the wiki bridge for README files. @icculus is that right?

@icculus
Copy link
Collaborator

icculus commented Mar 12, 2025

Yeah, I need to find some time to deal with this properly.

@icculus
Copy link
Collaborator

icculus commented Mar 13, 2025

I think the solution here is to move the README wiki pages out of a subdirectory and keep the original filename.

So you would get https://wiki.libsdl.org/SDL3/README-linux and links would would correctly (and as an added bonus, we could automatically hyperlink SDL symbols like we do for Doxygen text because they would be in the same wiki directory now).

We'll leave the current pages as redirects so existing links don't break.

@icculus
Copy link
Collaborator

icculus commented Mar 13, 2025

The other option is to just have the existing pages redirect to GitHub, which is easier but then they wouldn't be available in the offline wiki archive or look like the rest of the wiki, or be trivially editable, when online.

@slouken
Copy link
Collaborator

slouken commented Mar 13, 2025

I think the solution here is to move the README wiki pages out of a subdirectory and keep the original filename.

So you would get https://wiki.libsdl.org/SDL3/README-linux and links would would correctly (and as an added bonus, we could automatically hyperlink SDL symbols like we do for Doxygen text because they would be in the same wiki directory now).

We'll leave the current pages as redirects so existing links don't break.

This sounds great!

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

Successfully merging this pull request may close these issues.

3 participants