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 rgbasm-old.5 as an "Obsolete syntax" page #71

Merged
merged 4 commits into from
Dec 10, 2024
Merged

Add rgbasm-old.5 as an "Obsolete syntax" page #71

merged 4 commits into from
Dec 10, 2024

Conversation

Rangi42
Copy link
Contributor

@Rangi42 Rangi42 commented Dec 10, 2024

This is meant to go along with gbdev/rgbds#1571, so that when RGBDS 0.9.0 releases this month, it will have an online document of obsolete unsupported instructions and directives.

The main problem I'm running into is that previous versions of RGBDS did not have this new page, so yarn build fails. Maybe we should manually create stub rgbasm-old.5 pages for the old versions?

Feel free to push more commits to this branch to get it to work.

@Rangi42 Rangi42 requested review from avivace and ISSOtm December 10, 2024 14:20
@avivace
Copy link
Member

avivace commented Dec 10, 2024

I'm taking a look at this. A bit strange that yarn start lets you serve it with the dev server but build fails ..

@avivace
Copy link
Member

avivace commented Dec 10, 2024

@Rangi42 so, it seems like the error is correctly thrown, because we are redirecting /docs/<page> links to docs/<latestStable>/<page> ones. Since that page doesn't exist for 0.8.0 it can't create the placeholder page making the redirection.
I'd say we can start merging this without this specific redirection (so the page only appears in master version), the add it back when we release 0.9.0 and the redirect will make sense.

docusaurus.config.js Outdated Show resolved Hide resolved
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.

LGTM. I'll open an issue for new redirection.

@avivace avivace merged commit 7438442 into master Dec 10, 2024
@Rangi42
Copy link
Contributor Author

Rangi42 commented Dec 10, 2024

Thanks! With that change, yarn build works, and when I serve with yarn start, the "Obsolete syntax" sidebar item appears only in the master version, not the previous ones. Which is as expected.

image

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.

2 participants