meilisearch / meilisearch/documentation

Algolia migration guide improvement

Open
#2,822 2 comments 1 reaction 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

On an issue in the devrel repo, a user mentioned the following points:

It would be nice to mention that page in algolia starts from 0 and in meili from 1. Furthermore, attributesToSnippet doesn't exist and there is no mention of forwarding client IP for analytics using X-Forwarded-For for when our client is proxied by our own backend for frontend.

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 by locating the Algolia migration guide in the documentation and review the linked DevRel issue comment for context. Done means the guide explains the page-numbering difference, notes that attributesToSnippet is unavailable, and documents forwarding X-Forwarded-For for proxied analytics requests.

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
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.