doc: boards: Add ability to filter by SoC in the board catalog #79670
Conversation
kartben
added
area: Boards
area: Documentation
area: DX
kartben
changed the title
kartben
force-pushed
the
board_catalog_with_socs
branch
19 times, most recently
from
437b816 to
3c2eb6b
Compare
kartben
changed the title
kartben
force-pushed
the
board_catalog_with_socs
branch
from
3c2eb6b to
5cf41a7
Compare
I was waiting for someone to ask :) maybe, yes, but then that means you'd likely want to generalize this to all select fields (ex. selecting the vendor "ST" would only leave arm/arm64 in the arch list), and I'm undecided as to whether this makes for an improved UX or not. I think I like the ability to select the criteria completely independently of whether there might actually be any hits or not, and the ability to actually create a query that shows no result (as said query might return different results in the future) rather than preventing me from doing so. Think e.g https://builds.zephyrproject.io/zephyr/pr/79670/docs/boards/index.html#arch=riscv&vendor=st |
Yes, unselecting is through "Reset Filters" button at the moment, and it's not possible to select multiple archs or vendors, which is not the end of the world but also an unnecessary limitation. I will introduce multi-select (hence also ability to unselect) just like the family/series/soc fields in a future PR. |
Also, btw, there isn't really any information about the arch(s) of a given soc in the hardware model, and right now I'm getting the information by looking at what's in the twister file for all the board targets of a given board. If we are to implement something along the lines of what you suggest, I think it'd be needed to have the information readily/reliably available in the hardware model. |
Now that we have full_name available in board.yml, stop trying to "guess" full/commercial name of the board based on its documentation. Signed-off-by: Benjamin Cabé <[email protected]>
Store soc(s) information for each board in the catalog, as well as populate a tree structure for the full list of family->series->soc. Signed-off-by: Benjamin Cabé <[email protected]>
This introduces the ability to filter boards by soc (family / series / soc). Signed-off-by: Benjamin Cabé <[email protected]>
As the search form is becoming richer, provide some guidance on how to filter the list of supported boards and what to do when no results are found. Signed-off-by: Benjamin Cabé <[email protected]>
kartben
dismissed stale reviews from nashif, pdgendt, fabiobaltieri, carlescufi, and gmarull
via
1ea25f9
kartben
force-pushed
the
board_catalog_with_socs
branch
from
5cf41a7 to
1ea25f9
Compare
|
rebased to get rid of the commits now merged with #79708 |
kartben
requested review from
nashif,
pdgendt,
carlescufi,
gmarull and
fabiobaltieri
|
One comment on testing https://builds.zephyrproject.io/zephyr/pr/79670/docs/boards/index.html# |
@erwango I understand it can be confusing though so maybe this can be improved over time. |
https://builds.zephyrproject.io/zephyr/pr/79670/docs/boards/index.html
This introduces the ability to filter boards per SoC by adding a set of fields that allow to select
said SoC(s), possibly selecting entire families or series.
Sans.titre.mov
Although still reasonably straightforward, the search/filtering UI is becoming richer and richer. Therefore, the PR also introduces a short list of "search tips", including what to do when it doesn't seem like their board is supported.
This builds on #79708, so will be rebased once this other PR is merged.
FWIW, next improvement will be to introduce the ability to filter by HW capability (see #79754), and I will likely use this as an opportunity to also tidy up the JS code a bit.