summaryrefslogtreecommitdiffstats
path: root/browser/components/urlbar/docs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'browser/components/urlbar/docs/index.rst')
-rw-r--r--browser/components/urlbar/docs/index.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/browser/components/urlbar/docs/index.rst b/browser/components/urlbar/docs/index.rst
new file mode 100644
index 0000000000..633bca91b6
--- /dev/null
+++ b/browser/components/urlbar/docs/index.rst
@@ -0,0 +1,26 @@
+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
+
+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 has not yet been rewritten for quantumbar.
+
+.. toctree::
+
+ overview
+ utilities
+ telemetry
+ debugging
+ experiments
+ contact