-
Notifications
You must be signed in to change notification settings - Fork 264
Improve coherence between dataset and examples #860
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
Related to meilisearch/devrel#134 |
Adding to the list of examples that must be fixed: /reference/features/search_parameters.md Some of the examples will be fixed by #1016, but I am sure that at least one of them still refers to the |
Some problems with this proposition:
|
I missed the suggestion regarding expanding the dataset. I agree we should not add fields — if anything, I'd prefer Perhaps we should only reference specific datasets in guides and tutorials (e.g. quick start, how-to articles, etc) and dissociate our examples from the This would mean moving examples away from movies and use different types of examples to imply we are not assuming users to be familiar with |
2061: review filtering guide r=maryamsulemani97 a=maryamsulemani97 closes #1902, #860, #837, and #1850 - moves all operators to a new heading - removes SQL syntax and combines it with the curl code samples - replaces amazon and imdb images for facets with meilisearch demo images - removes unused images in `.vuepress/public/faceted-search` - remove redundant code samples <hr> - Improve coherence between dataset and examples - A sample document was added as part of #2050 with `rating` and `director` fields - This PR uses `movie_ratings` instead of `movies` to clarify that this is a separate dataset - `faceted_search_facets_1` still uses `movies` as this code sample is used in the API reference as well Co-authored-by: Maryam Sulemani <[email protected]> Co-authored-by: Maryam <[email protected]> Co-authored-by: maryamsulemani97 <[email protected]>
2061: review filtering guide r=maryamsulemani97 a=maryamsulemani97 closes #1902, #860, #837, and #1850 - moves all operators to a new heading - removes SQL syntax and combines it with the curl code samples - replaces amazon and imdb images for facets with meilisearch demo images - removes unused images in `.vuepress/public/faceted-search` - remove redundant code samples <hr> - Improve coherence between dataset and examples - A sample document was added as part of #2050 with `rating` and `director` fields - This PR uses `movie_ratings` instead of `movies` to clarify that this is a separate dataset - `faceted_search_facets_1` still uses `movies` as this code sample is used in the API reference as well Co-authored-by: Maryam Sulemani <[email protected]> Co-authored-by: Maryam <[email protected]> Co-authored-by: maryamsulemani97 <[email protected]>
Currently, the documentation provides examples that mention fields not present in the dataset available for download, like
director
orrating
.You can see it one the faceted search section: https://docs.meilisearch.com/reference/features/faceted_search.html#setting-up-facets or in the filtering one: https://docs.meilisearch.com/reference/features/filtering.html#examples
We could either add those fields to the dataset or replace the examples.
The text was updated successfully, but these errors were encountered: