fune/browser/components/urlbar/docs
Drew Willcoxon b551362822 Bug 1854755 - Add suggested_index and suggested_index_relative_to_group to Suggest pings. r=nanj
This adds two new fields to the Suggest PingCentre and Glean pings:

* `suggested_index` -
  An integer value that is the intended index of the suggestion
  being interacted with. If `suggested_index_relative_to_group` is true, the
  index is relative to the "Firefox Suggest" group; otherwise the index is
  relative to the entire list of suggestions. Non-negative values (starting
  at 0) are relative to the start/top of the group/list; negative values are
  relative to the end/bottom of the group/list.
* `suggested_index_relative_to_group` -
  Whether `suggested_index` is relative to the "Firefox Suggest" group. If
  false, it is relative to the entire list of suggestions.

In the Glean ping, `suggested_index` is stringified because there's no integer
metric type that can take negative numbers.

These two values reflect how the implementation works and will let us record any
indexes we want to experiment with. Suggestions are usually shown at the bottom
of the Firefox Suggest group, and in that case these values will be:

```
suggested_index = -1
suggested_index_relative_to_group = true
```

If we want to show suggestions at the top of the Firefox Suggest group instead
of the bottom, the values will be:

```
suggested_index = 0
suggested_index_relative_to_group = true
```

Differential Revision: https://phabricator.services.mozilla.com/D189035
2023-09-26 02:48:30 +00:00
..
assets
.rstcheck.cfg
contact.rst
debugging.rst
dynamic-result-types.rst
experiments.rst
firefox-suggest-telemetry.rst Bug 1854755 - Add suggested_index and suggested_index_relative_to_group to Suggest pings. r=nanj 2023-09-26 02:48:30 +00:00
index.rst
lifetime.rst
nontechnical-overview.rst
overview.rst
preferences.rst Bug 1840558 - Remove autofill search engines code. r=mak 2023-06-29 12:36:08 +00:00
ranking.rst
telemetry.rst Bug 1842247 - Integrate clipboard result feature with existing telemetry for success measurement. r=mak 2023-09-15 14:16:16 +00:00
testing.rst Bug 1827596 - Fix UrlbarTestUtils reference link in 'Adress Bar/Testing' 2023-04-29 07:59:55 +00:00
UrlbarController.rst
UrlbarInput.rst
UrlbarView.rst
utilities.rst