meilisearch / meilisearch/documentation
Consider improving the document template in the "Getting started with AI search" guide
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 174
- Forks
- 276
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 6
Description
The document template in this guide only uses the name from the document, which may result in subpar relevancy.
Furthermore, the link to the dataset appears dead from here: https://www.meilisearch.com/docs/assets/datasets/kitchenware.json
- Consider linking the document template best practices from the section that creates the template.
- If the dataset allows, consider including parts of the description or other semantically relevant fields for the kitchen material in the document template
- Should (2) prove difficult, then consider mentioning that this is a simple template for a sample dataset, and instruct to follow the best practices to optimize relevancy for production data
Not directly relevant to the document template, but mentioning somewhere in that guide that a rankingScoreThreshold should probably be used with semantic search would also help as it is a common pitfall for users.
Thank you for your consideration 😃
Context: https://github.com/meilisearch/meilisearch/issues/5608#issuecomment-2938951373
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the “Getting started with AI search” guide and the section that creates the document template. Verify the kitchenware dataset link, review the document template best practices page, and check how rankingScoreThreshold is described elsewhere. Done means the guide has a working dataset reference, clearer template guidance or a production-data caveat, and semantic-search threshold guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, search
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100