You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We want to signal to the user that your search for the current API will be filtered to use the historical API version for that API, rather than the current version. For example, if you're at /api/qiskit/0.19, then we'll search Qiskit 0.19 rather than latest of 1.0. But we still use 'latest' for the other APIs like Runtime. So, show something like Qiskit SDK 0.19.
This shouldn't be a changeable element, meaning you don't change the search filter via the search bar. Instead, you change the API version with the API version switcher in the left sidebar:
One concern is how much screen real estate this label might take up, such as to show the text 'Qiskit IBM Runtime Client 0.17'.
Consider with the design how we'll want to handle translations, if we show when search is being filtered to e.g. Spanish.
The text was updated successfully, but these errors were encountered:
Eric-Arellano
changed the title
Design: search should show when historical API doc filter is used
Design: allow changing historical API version filter in search?
Apr 15, 2024
#859 ended up adding a frontend, as screenshotted there. This issue is now about whether we want to allow users to change the search filter in a way different than changing the API url.
Update: @Vanguardbots is going to re-investigate this. We clarified that you do not need to change the URL to be able to search different API versions. We can search whatever we want from any page.
However, it's important that only one version of an API is searched at a time, e.g. only Qiskit 1.1 or 0.46, not both.
Follow up to #859.
We want to signal to the user that your search for the current API will be filtered to use the historical API version for that API, rather than the current version. For example, if you're at /api/qiskit/0.19, then we'll search Qiskit 0.19 rather than latest of 1.0. But we still use 'latest' for the other APIs like Runtime. So, show something like
Qiskit SDK 0.19
.This shouldn't be a changeable element, meaning you don't change the search filter via the search bar. Instead, you change the API version with the API version switcher in the left sidebar:
One concern is how much screen real estate this label might take up, such as to show the text 'Qiskit IBM Runtime Client 0.17'.
Consider with the design how we'll want to handle translations, if we show when search is being filtered to e.g. Spanish.
The text was updated successfully, but these errors were encountered: