meilisearch / meilisearch/documentation

synonym docs not clear

Open
#2,773 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

iphone and phone aren't great examples because I'd expect those to rank for each other regardless. I think you should keep the resume => cv example going

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 from the synonym documentation page containing the iphone/phone and resume => cv examples. Replace the unclear example with the suggested resume => cv example, then verify that the documentation clearly explains the intended synonym behavior.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.