Search UI Docs feedback and suggestions
JasonStoltz opened this issue · 6 comments
Have you had a chance to check out the new docs site for Search UI? You can find it here: https://docs.elastic.co/search-ui/overview.
We'd love to hear what you think. In particular, are there any guides you'd like to see us write up? We'd be happy to help you out there.
actually i love the new docs they are great. Where or how do we give feedback i dont see the ability to comment or ask in the docs?
For example the filters for the product listing page show https://docs.elastic.co/search-ui/solutions/ecommerce/product-listing-page
// adding a filter to only show TVs
filters: [{ field: "parent_category", values: ["TVs"] }]
But id does not show how to do a more complex nested any all query
"filters": {
"all": [
{ "states": "California" },
{ "world_heritage_site": "true" }
],
"any": [
{ "acres": { "from": 40000 } },
{ "square_km": { "from": 500 } }
],
"none": [
{ "title": "Yosemite" }
]
}
There's no inline way to give feedback, currently. Any feedback here is much appreciated.
Folks could also consider adding specific issues in the repository tagged with the docs
tag.
Regarding the issue you mention, I think a simple link out from that section to the full filter syntax would be beneficial.
What specifically isn't working? The type is documented here: https://docs.elastic.co/search-ui/api/core/actions#filtervalue--filtertype-types. More detail can be found here: https://www.elastic.co/guide/en/app-search/current/filters.html. If something isn't working there, create a separate issue and we can continue the conversation there.
I've been working on React Native app so am using the SearchDriver from search-ui and app search connector as the other packages with providers are using DOM history etc.
My feedback would be to include some links to docs where I can learn more about the inner workings whats going on, for example addFilter takes a few arguments, the first two are self explanatory but all | any | none
doesn't mean anything to me and I'm not sure where to get those answers?
I think there's a lot of assumed knowledge in the docs which as a reader I always find quite frustrating although I get the feeling that app search is meant to as easily accessible as possible without much prior knowledge? Once I start to come up against issues I'm not sure where to turn to.