Skip to content

Search parameters response / _formatted guide #1626

Open
@dichotommy

Description

@dichotommy

On the "guide" side of Meilisearch's documentation, we are missing a key resource: a solid guide on searching and understanding the search response.

Specifically, the _formatted field—which is added to search responses when certain parameters are given—is not described in detail in the Learn section of the site, which could make it easy to miss.

Search information can be very spread out on our site, so it would also just be good to have a place to consolidate links to different sections that directly relate to search, e.g. search parameters, known limitations, api keys.

Could also be part of the Meilisearch 101 guide.

A potential structure for the guide:

  1. Making an example search (q search parameter)
  2. Breaking down the search response (hits array, exhaustiveness, etc.)
  3. Adding search parameters (with corresponding looks at responses)
  • attributesToHighlight
  • matches
  • crop
  1. Conclusion: links to API reference, API keys guide and anything else that's really relevant (e.g. if in the future we add an article on Meilisearch's intended design patterns—what should happen from the front-end vs. from the back-end—it could be linked here)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions