improve doc search
(Split from https://github.com/spdx/spdx-3-model/issues/1164)
The doc search can take some improvement:
- https://spdx.github.io/spdx-spec/v3.1-dev/search.html?q=cdx* finds all relevant terms
- And even works dynamically, i.e. as soon as I type
cdx*in the main search box - But without a star, none of this finds:
cdx, cdxprop. Onlycdxpropertyfinds. Please enable implicit wildcard at the end, after say 3 chars typed by the user - There is no "autocomplete" behavior in the left-pane search box.
BTW, do you use readthedocs to generate the documentation?
We currently use MkDocs with its "readthedocs" lookalike theme and its default search plugin.
Nothing you can change much with it apart from the shortest length of words for indexing (default is 3, but have to be adjusted to 2 as we have the 'to' property).
On the star search, interesting. Thanks for putting this to our awareness. Not sure if we can enable this by default.
Or maybe find a way to put a sentence in the search page that you can put * there
How about using
- https://squidfunk.github.io/mkdocs-material/. You can make the doc very attractive with this
- see https://www.albrittonanalytics.com/features/search/
- or Algolia search (i guess it's paid?)