fune/browser/components/urlbar/docs/index.rst
Drew Willcoxon c1f58d3e1f Bug 1714418 - Fix broken Architecture Overview link in urlbar doc index.rst. r=harry
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

Differential Revision: https://phabricator.services.mozilla.com/D116761
2021-06-03 19:50:21 +00:00

44 lines
1.3 KiB
ReStructuredText

Address Bar
===========
This document describes the implementation of Firefox's address bar, also known
as the quantumbar or urlbar. The address bar was also called the awesomebar
until Firefox 68, when it was substantially rewritten.
The address bar is a specialized search access point that aggregates data from
several different sources, including:
* Places (Firefox's history and bookmarks system)
* Search engines (including search suggestions)
* WebExtensions
* Open tabs
Where to Start
--------------
If you want a high level, nontechnical summary of how the address bar works,
read :doc:`nontechnical-overview`.
If you are interested in the technical details, you might want to skip ahead to
:doc:`overview`.
Codebase
--------
Most of the address bar code lives in `browser/components/urlbar <https://searchfox.org/mozilla-central/source/browser/components/urlbar/>`_.
A separate and important back-end piece currently is `toolkit/components/places/UnifiedComplete.jsm <https://searchfox.org/mozilla-central/source/toolkit/components/places/UnifiedComplete.jsm>`_, which was carried over from awesomebar and is
undergoing refactoring for quantumbar.
Table of Contents
-----------------
.. toctree::
nontechnical-overview
overview
utilities
telemetry
debugging
experiments
dynamic-result-types
contact