search

gbdev / rgbds-www

RGBDS website, hosting documentation and install instructions. Built with Docusaurus, content from RGBDS man pages.
https://rgbds.gbdev.io
Other
7 stars 8 forks source link

"See also" links on man pages are broken #45

Closed DaKnig closed 9 months ago

DaKnig commented 1 year ago

the website mentions the page rgbasm.5 multiple times, but links to a non existing page rgbds.5/rgbasm.5 which 404s...

ISSOtm commented 1 year ago

Discussion at gbdev/rgbds#1133

Rangi42 commented 10 months ago

The man pages themselves are fine; the fix for this will be some change to rgbds-www. So this is the GitHub issue for resolving it.

ISSOtm commented 10 months ago

Copying what was said over there:

The problem is that the URLs used to be served without a trailing slash, and then the relative links worked correctly. Something changed, and now trailing slashes are enforced by GitHub Pages; two possible fixes are to either add a ../, or to use the full path from the root.

Thoughts on which one is preferable?

[Full paths] however require modifying the generated HTML, which is its own pile of problems...

DaKnig commented 10 months ago

any downsides to adding trailing slash?

ISSOtm commented 10 months ago

I've pinpointed what the "something" that changed is: I'm not sure why, but Docusaurus generates the pages as index.html in directories! This is why GitHub enforces the trailing slash.

Is there a way to make Docusaurus... not do that? Worst case, we can run a post-process script that moves the pages appropriately, but then local setups would still be broken, among other things.