open-horizon.github.io
open-horizon.github.io copied to clipboard
open-horizon
Documentationđź“„: Add a doc search function/field
What is the current documentation state?
Add a search field that would search the entire documentation set. Here is an example from IEAM 4.3:
Where is this stated?
No response
Why do you want to improve the statement?
No response
Proposed Statement
No response
Additional context.
No response
If possible, I'd like to see if we can use an inline search tool like https://www.algolia.com/ref/docsearch/
One reason is speed and instant feedback. Another reason is that it avoids injection attacks by not showing a page that includes search terms typed in by the visitor. LMK if it's not clear why that's so important.
The Jekyll web site uses this type of search: https://jekyllrb.com
Do a search for build or install. One of the nice features is that it gives feedback so quickly that you can type more slowly and see instant results with every keypress.
I also love how it groups results into sections.
If possible, I'd like to see if we can use an inline search tool like https://www.algolia.com/ref/docsearch/
One reason is speed and instant feedback. Another reason is that it avoids injection attacks by not showing a page that includes search terms typed in by the visitor. LMK if it's not clear why that's so important.
The Jekyll web site uses this type of search: https://jekyllrb.com
Do a search for
buildorinstall. One of the nice features is that it gives feedback so quickly that you can type more slowly and see instant results with every keypress.I also love how it groups results into sections.
I will look into this :)
maybe CDS solves this too : https://www.carbondesignsystem.com/components/search/usage/
@joewxboy we can close this issue now, resolved via https://github.com/open-horizon/open-horizon.github.io/pull/376