summaryrefslogtreecommitdiffstats
path: root/browser/components/search/docs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'browser/components/search/docs/index.rst')
-rw-r--r--browser/components/search/docs/index.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/browser/components/search/docs/index.rst b/browser/components/search/docs/index.rst
new file mode 100644
index 0000000000..a608a12876
--- /dev/null
+++ b/browser/components/search/docs/index.rst
@@ -0,0 +1,23 @@
+Search
+======
+
+This document describes the implementation of parts of Firefox's search interfaces.
+
+The search area covers:
+
+ * Search bar on the toolbar
+ * In-content search
+ * One-off search buttons on both the search and address bars
+
+Search Engine handling is taken care of with the `toolkit Search Service`_.
+
+Most of the search code lives in `browser/components/search`_.
+
+.. toctree::
+
+ application-search-engines
+ Preferences
+ telemetry
+
+.. _toolkit Search Service: /toolkit/search/index.html
+.. _browser/components/search: https://searchfox.org/mozilla-central/source/browser/components/search