Skip to content

Conversation

@Rangi42
Copy link
Contributor

@Rangi42 Rangi42 commented Jan 14, 2026

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 unreleased master docs.

Copy link
Member

@avivace avivace left a 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.

@Rangi42
Copy link
Contributor Author

Rangi42 commented Jan 14, 2026

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 /v0.5.2/, some to /v0.6.1/, etc.

@ISSOtm
Copy link
Member

ISSOtm commented Jan 14, 2026

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 {{#include "rgbds_ver.txt"}} inline would work, but if not, we can always add our own plumbing.)

@avivace
Copy link
Member

avivace commented Jan 15, 2026

@ISSOtm

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 {{#include "rgbds_ver.txt"}} inline would work, but if not, we can always add our own plumbing.)

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.

@Rangi42

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 /v0.5.2/, some to /v0.6.1/, etc.

We don't have an "alias" / link to the "latest" minor of 1.x on the rgbds website, right?

Copy link
Member

@avivace avivace left a 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 !

@avivace avivace merged commit 4a88fc5 into gbdev:master Jan 15, 2026
3 checks passed
@Rangi42 Rangi42 deleted the doc-link branch January 15, 2026 10:23
@ISSOtm
Copy link
Member

ISSOtm commented Jan 15, 2026

This may be a cool 'further improvement', albeit it entails a lot of additional work

If we can make it work with just the built-in {{#include}}, then that's hardly any additional work. I should give that a try, and open an issue to track the item if more work is involved. Let's say tomorrow after a good night of sleep 😅

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