Open Bug 1648402 Opened 4 years ago Updated 3 years ago

Relative links to md file + anchor are not resolved on the devtools docs published with Sphinx

Categories

(DevTools :: Documentation, defect, P3)

defect

Tracking

(Not tracked)

People

(Reporter: jdescottes, Unassigned)

References

Details

In the devtools documentation, we sometimes use links to a specific anchor in another documentation page.

Example:

  * `devtools/server/actors`: [RDP Actors](../backend/protocol.md#actors). 

https://searchfox.org/mozilla-central/rev/a87a1c3b543475276e6d57a7a80cb02f3e42b6ed/devtools/docs/files/README.md#9

If you click on the link RDP Actors on https://firefox-source-docs.mozilla.org/devtools/files/README.html it will open https://firefox-source-docs.mozilla.org/devtools/backend/protocol.md#actors (note the protocol.md here).

Comparatively on the old doc website: https://docs.firefox-dev.tools/files/ , clicking on the same link successfully navigates to https://docs.firefox-dev.tools/backend/protocol.html#actors (note protocol.html).

Links which don't have an anchor after the .md seem fine on both platforms.

This means we have a few dead links, blocking Bug 1615242.

Adding into this, https://firefox-source-docs.mozilla.org/devtools/about-documentation.html , clone the repository link also doesn't work.

The severity field is not set for this bug.
:Honza, could you have a look please?

For more information, please visit auto_nag documentation.

Flags: needinfo?(odvarko)
Severity: -- → S3
Flags: needinfo?(odvarko)
Priority: -- → P3

From Bug 1680444
(In reply to Sonia from Bug 1680444 comment #0)

User Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:83.0) Gecko/20100101 Firefox/83.0

Steps to reproduce:

Visit the page at https://firefox-source-docs.mozilla.org/devtools/about-documentation.html, the link with clone the repository needs to be fixed. It's 404 now!

I want to work on this issue :)

Thanks
Sonia

You need to log in before you can comment on or make changes to this bug.