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

Jump to bottom

Broken links in testharness.html (links to testharness-api.md not testharness-api.html) #26620

Open
miketaylr opened this issue Nov 23, 2020 · 2 comments
Open

Broken links in testharness.html (links to testharness-api.md not testharness-api.html) #26620

miketaylr opened this issue Nov 23, 2020 · 2 comments
Labels
docs

Comments

@miketaylr
Copy link
Member

miketaylr commented Nov 23, 2020 •
edited

STR:

  1. go to https://web-platform-tests.org/writing-tests/testharness.html#without-html-boilerplate-window-js
  2. click on "single thing", "asynchronous", or "promise tests"

Expected: it works
Actual: 404

You end up at https://web-platform-tests.org/writing-tests/testharness-api.md#asynchronous-tests, instead of https://web-platform-tests.org/writing-tests/testharness-api.html#asynchronous-tests

I don't know how Sphinx works at all, but it appears to not like .md#.

A lazy fix would be to just hardcode the hyperlink to point to html?
@miketaylr miketaylr added the docs label Nov 23, 2020
@Hexcles
Copy link
Member

Hexcles commented Nov 30, 2020

This seems like readthedocs/recommonmark#8

We could fix the issue on web-platform-tests.org by changing the link from .md to .html, but that'd break cross-linking on GitHub, sigh.

@miketaylr
Copy link
Member Author

I wonder if the workaround suggested in readthedocs/recommonmark#8 (comment) works (I guess I can try to figure out how to build docs), or if we want to be truly terrible, we could write some JS to modify the href to point to .html or .md based on location.origin 🙈

@ghostd ghostd mentioned this issue Jan 4, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@miketaylr @Hexcles