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

Add links to the corresponding SDL3 pages in the SDL2 wiki pages #713

Closed
captain0xff opened this issue Jan 23, 2025 · 8 comments
Closed
Assignees

Comments

@captain0xff
Copy link

From discord:

Can we have a link on the SDL2 wiki pages pointing to the SDL3 ones? Search engines prioritise the SDL2 pages and in some cases the SDL3 one is not even there in the top 5 results. There is a message showing that it is the legacy documentation and a link to the SDL3 front page but not to the relevant SDL3 page. This will make migration a lot easier. I think this can be automated by parsing the migration script or guide.

@icculus
Copy link
Contributor

icculus commented Jan 24, 2025

Okay, this is done. I actually had this written before, so I just uncommented it. :)

So this page doesn't have an SDL3 equivalent, looks like it usually does:

https://wiki.libsdl.org/SDL2/SDL_OpenAudio

This one does, so it has a note at the top:

https://wiki.libsdl.org/SDL2/SDL_OpenAudioDevice

We can make that more pronounced or whatever. Otherwise, this is good to go.

@icculus icculus self-assigned this Jan 24, 2025
@slouken
Copy link
Contributor

slouken commented Jan 24, 2025

I don't think we need to be quite so verbose, maybe, e.g.

[SDL Wiki](https://wiki.libsdl.org/)
(This is the legacy documentation for SDL2, the previous stable version; [SDL3](https://wiki.libsdl.org/SDL3/) is the current stable version.)

can be:

[SDL2 Wiki](https://wiki.libsdl.org/SDL2)

and

[SDL Wiki](https://wiki.libsdl.org/)
[This page also has an [SDL3](https://wiki.libsdl.org/SDL3/SDL_OpenAudioDevice) equivalent.]
(This is the legacy documentation for SDL2, the previous stable version; [SDL3](https://wiki.libsdl.org/SDL3/) is the current stable version.)

can be:

[SDL2 Wiki](https://wiki.libsdl.org/SDL2)
(See [SDL_OpenAudioDevice](https://wiki.libsdl.org/SDL3/SDL_OpenAudioDevice) for the SDL3 version.)

(where SDL_OpenAudioDevice would be the correct symbol for renamed or replaced functions)

and

[SDL Wiki](https://wiki.libsdl.org/)
(This is the documentation for SDL3, which is the current stable version. [SDL2](https://wiki.libsdl.org/SDL2/) was the previous version!)

can be:

[SDL3 Wiki](https://wiki.libsdl.org/SDL3)

After a few months this will settle down and we don't need to be in everyone's face about it.

@icculus
Copy link
Contributor

icculus commented Jan 24, 2025

[SDL3 Wiki](https://wiki.libsdl.org/SDL3)

I'd rather this just say "SDL Wiki" for SDL3.

icculus added a commit to libsdl-org/SDL that referenced this issue Jan 24, 2025
icculus added a commit to libsdl-org/SDL that referenced this issue Jan 24, 2025
@icculus
Copy link
Contributor

icculus commented Jan 24, 2025

Okay, I think we're good now.

@icculus icculus closed this as completed Jan 24, 2025
@icculus icculus reopened this Jan 24, 2025
@icculus
Copy link
Contributor

icculus commented Jan 24, 2025

Wait, no, I broke something.

@slouken
Copy link
Contributor

slouken commented Jan 24, 2025

Can we follow function renaming? e.g. SDL_FreeSurface will point at SDL_DestroySurface?

@slouken
Copy link
Contributor

slouken commented Jan 24, 2025

Actually, never mind, this is to help people landing on the wrong page for Google results, not assist in code migration.

@slouken
Copy link
Contributor

slouken commented Jan 24, 2025

Looks good!

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

3 participants