epubcheck icon indicating copy to clipboard operation
epubcheck copied to clipboard

Internal links in documentation site are broken

Open elmimmo opened this issue 4 years ago • 2 comments

Most internal links at https://w3c.github.io/epubcheck/ point to somewhere below /publishing/epubcheck/…, where there seems to be nothing.

Instead of fixing the /publishing/ part, though, having those simply be relative to the document they are in instead of the site’s root (specially when they point to a lower level in the tree hierarchy) should make it more future-proof and easier to maintain.

elmimmo avatar Jul 05 '21 09:07 elmimmo

the canonical URL of the site is https://www.w3.org/publishing/epubcheck/. That's why the links use /publishing/epubcheck/ as a prefix.

But due to technical limitations, redirection from the github.io to w3.org domain cannot be configured. We'll look into how to improve the situation. If needed, we can always use absolute URLs everywhere 🤔

rdeltour avatar Jul 05 '21 09:07 rdeltour

If needed, we can always use absolute URLs everywhere

My suggestion was actually relative URLs everywhere, but to the document instead of the root. For instance, “Introduction” at https://w3c.github.io/epubcheck/docs/ should link to getting-started/ instead of /epubcheck/docs/getting-started/ (or the current /publishing/epubcheck/docs/getting-started/).

elmimmo avatar Jul 05 '21 09:07 elmimmo