meilisearch / meilisearch/documentation

Synonym limitation

Open Beginner friendly
#2,676 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

fix/improvement good first issue
Dominant language
MDX
Stars
174
Forks
276
Avg merge
2d 1h
Merged PRs (30d)
6

Description

Hello,
After speaking with @dureuill, we forgot to mention a limitation about synonyms.
The part Maximum number of synonyms per term is correct, and we don't want to change it.
However, there is a limitation on the term itself. Meilisearch only fetches the synonyms for the 1 to 3-word terms and not more.
This means that if you add a synonym the lord of the Rings -> lotr, you will never find a document containing lotr by searching the lord of the Rings.
It only the case for the term but not for their synonyms, which means that if you add a synonym lotr -> the lord of the Rings, you will find a document containing the lord of the Rings by searching lotr.

We may add a section explaining this limitation.

Don't hesitate to ask more questions if you need them.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the “Maximum number of synonyms per term” section linked in the issue and review the surrounding synonyms documentation. Add a section explaining the 1-to-3-word limitation for terms, including the contrasting examples given, and verify that the existing maximum-synonyms guidance remains unchanged.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.