magic-wormhole icon indicating copy to clipboard operation
magic-wormhole copied to clipboard

Two links in generated documentation lead to 404

Open gregsadetsky opened this issue 3 years ago • 3 comments

On this documentation page, under the "Relays" paragraph, there are two broken links:

  • "named magic-wormhole-mailbox-server and has documentation here" (404 link)
  • "Code for the Transit Relay is provided a separate package named magic-wormhole-transit-relay with instructions here" (404 link)

Both links are 404 as they - in the source .md files - link to:

  • https://github.com/warner/magic-wormhole-mailbox-server/blob/master/docs/welcome.md (source link)
  • https://github.com/warner/magic-wormhole-transit-relay/blob/master/docs/running.md (source link)

... but Sphinx (or read the docs?) incorrectly transforms those markdown links as it strips the .md extensions, thereby creates incorrect links.

gregsadetsky avatar Apr 08 '23 17:04 gregsadetsky

Should i resolve this Bug?

MiirzaBaig avatar May 20 '23 11:05 MiirzaBaig

@I-MirzaBaig if you know how to fix it, a PR would be great!

meejah avatar May 20 '23 18:05 meejah

Will try my best!

MiirzaBaig avatar May 21 '23 04:05 MiirzaBaig

This seems to be fixed, feel free to reopen if needed

shapr avatar Apr 30 '25 15:04 shapr