doc: Add search by compatibles in the board catalog #97557
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kartben
force-pushed
the
add_compatible_search
branch
2 times, most recently
from
cf56855 to
8d9057c
Compare
kartben
force-pushed
the
add_compatible_search
branch
3 times, most recently
from
adfffaf to
008238a
Compare
This adds a role that can be used to reference the board catalog page, optionally with filter parameters to pre-filter the list of boards. Signed-off-by: Benjamin Cabé <[email protected]>
This commits adds a `compatibles` field to each board entry in the board catalog, similar to the `supported_features` field. Signed-off-by: Benjamin Cabé <[email protected]>
There might be different UI widgets that deal with tags so make sure that we use identifiers and selectors that are not too generic. Signed-off-by: Benjamin Cabé <[email protected]>
…alog This adds the ability to filter boards in the catalog by compatible strings. It supports wildcards so e.g. one can quickly find all boards with an "st,lsm*" accelerometer. Signed-off-by: Benjamin Cabé <[email protected]>
This adds a link to the board catalog in the sidebar of each binding page, directing users to boards using the compatible. Signed-off-by: Benjamin Cabé <[email protected]>
kartben
force-pushed
the
add_compatible_search
branch
from
008238a to
36994ee
Compare
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds the ability to filter boards in the catalog by compatible strings. It supports wildcards so e.g. one can quickly find all boards with e.g. an
st,lsm*accelerometer.Search by compatible in the catalog
Cross-referencing boards from the documentation page of a binding
As a bonus, binding documentation also now has nice cross-linking to list of boards that use the compatible
Depends on (commits from these PRs are included in this PR until they are merged):