-
-
Notifications
You must be signed in to change notification settings - Fork 54
Consistently link to the latest RGBDS docs #155
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Gb-asm-tutorial is targeting 0.5.x, as specified in Setup.
If anything, I'd start by upgrading the suggested/target version to 1.x.x
I also don't think it'd a good idea to change the links to point to the latest version. It's literally a moving surface and changes to new majors should be made explicitly and consciously.
|
So, you would rather change all the links which currently don't specify a version (that's the majority of them right now), and have them specify whatever version is appropriate. I can do that, although then we'd still be prone to accidentally linking the wrong version -- as some of these links did, note some going to |
|
We could use the mdBook preproc to interpolate in the RGBDS version number, so that there's a single source of truth for it? (Perhaps |
This may be a cool 'further improvement', albeit it entails a lot of additional work + new config, templating etc so I wouldn't say it's a priority right now. Feel free to open a Issue detailing the idea.
We don't have an "alias" / link to the "latest" minor of 1.x on the rgbds website, right? |
avivace
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't realise most of them are already linking to 'latest'. Let's make that consistent first and then possibly think about 'locking' them to a major. Thanks @Rangi42 !
If we can make it work with just the built-in |
Most links already went to
https://rgbds.gbdev.io/docs/...for the latest release version of any page, but some were hard-coded to specific old versions, or to the unreleasedmasterdocs.