summaryrefslogtreecommitdiffstats
path: root/toolkit/components/search/docs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'toolkit/components/search/docs/index.rst')
-rw-r--r--toolkit/components/search/docs/index.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/toolkit/components/search/docs/index.rst b/toolkit/components/search/docs/index.rst
new file mode 100644
index 0000000000..188f020ebf
--- /dev/null
+++ b/toolkit/components/search/docs/index.rst
@@ -0,0 +1,28 @@
+==============
+Search Service
+==============
+
+This is documentation for the Search Service.
+
+Definitions
+===========
+
+* Application-provided engine (aka app-provided): This is an engine that is
+ provided by the application to the user as part of the configurations for the
+ user's locale/region.
+* Default engine: This is the engine that is the one used by default when
+ doing searches from the address bar, search bar and other places. This may be
+ a default application provided engine or a user selected engine.
+* Default private engine: Same as for the default engine, but this is used by
+ default when in private browsing mode.
+
+Contents
+========
+
+.. toctree::
+ :maxdepth: 2
+
+ SearchEngineConfiguration
+ SearchConfigurationSchema
+ DefaultSearchEngines
+ Telemetry