1714418 - Urlbar docs: In index.rst, the Architecture Overview link in the Where to Start section is broken

Status: RESOLVED FIXED

(Firefox :: Address Bar, defect, P5)

Description

[Drew Willcoxon :adw]

In index.rst, the Architecture Overview link in the Where to Start section links to an unrelated page in the devtools docs.

Comment 1

[Drew Willcoxon :adw]

Attachment: Bug 1714418 - Fix broken Architecture Overview link in urlbar doc index.rst.

This fixes it locally for me. Apparently :ref: links to the first matching
global label, which in this case is an unrelated "Architecture overview" label
in a devtools doc. Instead we can use :doc: to link to another doc in the same
directory. We only need to specify the doc file's basename and Sphinx
automatically includes the doc's title in the final HTML.

See: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-doc

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/93073498828f
Fix broken Architecture Overview link in urlbar doc index.rst. r=harry

Comment 3

[Atila Butkovits]

https://hg.mozilla.org/mozilla-central/rev/93073498828f