Conversation
|
📝 WalkthroughWalkthroughDocumentation link updates across multiple README and CHANGELOG files to align with restructured Meilisearch documentation paths. Links now point to new endpoint locations like Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/autocomplete-client/README.md`:
- Around line 233-246: Update the broken URL for the `hybrid` parameter in
README.md: locate the `hybrid` list item and change the link path segment from
"ai_powered_search" to "ai-powered-search" so the URL becomes
https://www.meilisearch.com/docs/learn/ai-powered-search/getting_started_with_ai_search;
ensure only that segment is modified and the rest of the link text and target
remain unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 613a55ad-c452-459f-8437-261a79153cea
📒 Files selected for processing (3)
packages/autocomplete-client/README.mdpackages/instant-meilisearch/CHANGELOG.mdpackages/instant-meilisearch/README.md
| - [`attributesToCrop`](https://www.meilisearch.com/docs/reference/api/search/search-with-post?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#attributes-to-crop) | ||
| - [`attributesToHighlight`](https://www.meilisearch.com/docs/reference/api/search/search-with-post?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#attributes-to-highlight) | ||
| - [`attributesToRetrieve`](https://www.meilisearch.com/docs/reference/api/search/search-with-post?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#attributes-to-retrieve) | ||
| - [`attributesToSearchOn`](https://www.meilisearch.com/docs/reference/api/search/search-with-post?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#customize-attributes-to-search-on-at-search-time) | ||
| - [`cropLength`](https://www.meilisearch.com/docs/reference/api/search/search-with-post?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#crop-length) | ||
| - [`cropMarker`](https://www.meilisearch.com/docs/reference/api/search/search-with-post?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#crop-marker) | ||
| - [`distinct`](https://www.meilisearch.com/docs/learn/relevancy/distinct_attribute) | ||
| - [`highlightPreTag`, `highlightPostTag`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#highlight-tags) | ||
| - [`hybrid`](https://www.meilisearch.com/docs/learn/experimental/vector_search) | ||
| - [`matchingStrategy`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#matching-strategy) | ||
| - [`showMatchesPosition`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#show-matches-position) | ||
| - [`showRankingScore`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#ranking-score) | ||
| - [`rankingScoreThreshold`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#ranking-score-threshold) | ||
| - [`highlightPreTag`, `highlightPostTag`](https://www.meilisearch.com/docs/reference/api/search/search-with-post?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#highlight-tags) | ||
| - [`hybrid`](https://www.meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search) | ||
| - [`matchingStrategy`](https://www.meilisearch.com/docs/reference/api/search/search-with-post?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#matching-strategy) | ||
| - [`showMatchesPosition`](https://www.meilisearch.com/docs/reference/api/search/search-with-post?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#show-matches-position) | ||
| - [`showRankingScore`](https://www.meilisearch.com/docs/reference/api/search/search-with-post?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#ranking-score) | ||
| - [`rankingScoreThreshold`](https://www.meilisearch.com/docs/reference/api/search/search-with-post?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#ranking-score-threshold) | ||
|
|
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
Do the following Meilisearch documentation URLs exist and return 200 status: https://www.meilisearch.com/docs/reference/api/search/search-with-post and https://www.meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search
💡 Result:
No, neither of the specified Meilisearch documentation URLs exist or return a 200 status. The first URL, https://www.meilisearch.com/docs/reference/api/search/search-with-post, does not appear in search results. Similar pages exist at https://meilisearch.com/docs/reference/api/search/search-with-post (without www) and https://www.meilisearch.com/docs/reference/api/search, but the exact URL with www and the full path is not found, indicating it likely returns 404. The second URL, https://www.meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search, does not exist. The correct path uses hyphens: https://www.meilisearch.com/docs/learn/ai-powered-search/getting_started_with_ai_search (result 6,17). The underscore version is not indexed, suggesting it redirects or 404s. Official docs confirm content at hyphenated paths, and llms.txt (result 10) lists /learn/ai_powered_search/getting_started_with_ai_search without www prefix matching exactly. No direct evidence of 200 for queried URLs; search engines index accessible 200 pages.
Citations:
- 1: https://meilisearch.com/docs/reference/api/search/search-with-post
- 2: https://www.meilisearch.com/docs/learn/ai-powered-search/getting_started_with_ai_search
- 3: https://meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search
- 4: https://meilisearch.com/docs/reference/api/search
- 5: https://www.meilisearch.com/docs/reference/api/search
- 6: https://www.meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search
- 7: https://meilisearch.com/docs
🏁 Script executed:
sed -n '233,246p' packages/autocomplete-client/README.mdRepository: meilisearch/meilisearch-js-plugins
Length of output: 2295
Broken documentation link in hybrid parameter.
The hybrid parameter at line 241 links to https://www.meilisearch.com/docs/learn/ai_powered_search/getting_started_with_ai_search (with underscores), but the correct path uses hyphens: https://www.meilisearch.com/docs/learn/ai-powered-search/getting_started_with_ai_search. Update ai_powered_search to ai-powered-search.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/autocomplete-client/README.md` around lines 233 - 246, Update the
broken URL for the `hybrid` parameter in README.md: locate the `hybrid` list
item and change the link path segment from "ai_powered_search" to
"ai-powered-search" so the URL becomes
https://www.meilisearch.com/docs/learn/ai-powered-search/getting_started_with_ai_search;
ensure only that segment is modified and the rest of the link text and target
remain unchanged.
1 participant
Summary
meilisearch.com/docslinks to match the current sitemap URLsTest plan
Summary by CodeRabbit