Skip to content

Commit 6da49bd

Browse files
multiple minor fixes
1 parent b4e29e9 commit 6da49bd

File tree

22 files changed

+128
-220
lines changed

22 files changed

+128
-220
lines changed

guides/ai/mcp.mdx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,14 @@ You can also request your search uses other Meilisearch features such as filters
153153
Search the "products" index for "chair" where the price is less than 200 and the category is "Furniture". Sort results by price in ascending order.
154154
```
155155

156-
<Capsule intent="warning" title="Important note about LLM limitation">
156+
<Warning>
157+
158+
### Important note about LLM limitation
159+
157160
Large Language Models like Claude tend to say "yes" to most requests, even if they can't actually perform them.
158161

159162
Claude can only perform actions that are exposed through the Meilisearch API and implemented in the MCP server. If you're unsure whether a particular operation is possible, refer to the [Meilisearch documentation](https://docs.meilisearch.com) and the [MCP server README](https://github.com/meilisearch/meilisearch-mcp).
160-
</Capsule>
163+
</Warning>
161164

162165
## Troubleshooting
163166

learn/ai_powered_search/choose_an_embedder.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ Although it returns very relevant search results, the Hugging Face embedder must
2929

3030
That said, Hugging Face can be a good embedder for datasets under 10k documents that you don't plan to update often.
3131

32-
<Capsule intent="note">
32+
<Note>
3333
Meilisearch Cloud does not support embedders with `{"source": "huggingFace"}`.
3434

35-
To use Hugging Face in the Cloud, use [HuggingFace inference points with the REST embedder](/guides/ai/huggingface).
36-
</Capsule>
35+
To implement Hugging Face embedders in the Cloud, use [HuggingFace inference points with the REST embedder](/guides/ai/huggingface).
36+
</Note>

learn/multi_search/implement_sharding.mdx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,18 @@ title: Implement sharding with remote federated search
33
description: This guide walks you through implementing a sharding strategy by activating the `/network` route, configuring the network object, and performing remote federated searches.
44
---
55

6+
import { NoticeTag } from '/snippets/notice_tag.mdx';
7+
68
import CodeSamplesMultiSearchRemoteFederated1 from '/snippets/samples/code_samples_multi_search_remote_federated_1.mdx';
79

810
Sharding is the process of splitting an index containing many documents into multiple smaller indexes, often called shards. This horizontal scaling technique is useful when handling large databases. In Meilisearch, the best way to implement a sharding strategy is to use remote federated search.
911

1012
This guide walks you through activating the `/network` route, configuring the network object, and performing remote federated searches.
1113

12-
<Capsule intent="tip" title="Configuring multiple instances">
14+
<Tip>
15+
## Configuring multiple instances
1316
To minimize issues and limit unexpected behavior, instance, network, and index configuration should be identical for all shards. This guide describes the individual steps you must take on a single instance and assumes you will replicate them across all instances.
14-
</Capsule>
17+
</Tip>
1518

1619
## Prerequisites
1720

learn/self_hosted/configure_meilisearch_at_launch.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -249,11 +249,13 @@ Migrates the database to a new Meilisearch version after you have manually updat
249249

250250
[Learn more about updating Meilisearch to a new release](/learn/update_and_migration/updating).
251251

252-
<Capsule intent="danger" title="Create a snapshot before a dumpless upgrade">
252+
<Warning>
253+
#### Create a snapshot before a dumpless upgrade
254+
253255
Take a snapshot of your instance before performing a dumpless upgrade.
254256

255257
Dumpless upgrade are not currently atomic. It is possible some processes fail and Meilisearch still finalizes the upgrade. This may result in a corrupted database and data loss.
256-
</Capsule>
258+
</Warning>
257259

258260
### Dump directory
259261

learn/update_and_migration/updating.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,9 @@ Meilisearch should launch normally and immediately create a new `UpgradeDatabase
156156

157157
While the task is processing, you may continue making search queries. You may also enqueue new tasks. Meilisearch will only process new tasks once `UpgradeDatabase` is completed.
158158

159-
<Capsule intent="warning">
159+
<Warning>
160160
If after the upgrade is completed the task status is set to `failed` or Meilisearch returns internal error messages to your queries, [restart your instance from the snapshot](/learn/advanced/snapshots#starting-from-a-snapshot) you generated during step 1. You may then retry the upgrade, or upgrade using a dump. You are also welcome to open an issue on the [Meilisearch repository](https://github.com/meilisearch/meilisearch).
161-
</Capsule>
161+
</Warning>
162162

163163
### Using a dump
164164

reference/api/batches.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,8 +125,7 @@ List of the number of tasks in the batch separated by the indexes they affect.
125125

126126
## Get batches
127127

128-
<RouteHighlighter method="GET" path="/batches
129-
" />
128+
<RouteHighlighter method="GET" path="/batches" />
130129

131130
List all batches, regardless of index. The batch objects are contained in the `results` array.
132131

@@ -213,8 +212,7 @@ For example, `?uids=0` returns a batch containing the task with a `taskUid` equa
213212

214213
## Get one batch
215214

216-
<RouteHighlighter method="GET" path="/batches/{batch_uid}
217-
" />
215+
<RouteHighlighter method="GET" path="/batches/{batch_uid}" />
218216

219217
Get a single batch.
220218

reference/api/documents.mdx

Lines changed: 12 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: The /documents route allows you to create, manage, and delete docum
55
---
66

77
import { RouteHighlighter } from '/snippets/route_highlighter.mdx'
8-
8+
import { NoticeTag } from '/snippets/notice_tag.mdx';
99

1010
import CodeSamplesAddOrReplaceDocuments1 from '/snippets/samples/code_samples_add_or_replace_documents_1.mdx';
1111
import CodeSamplesAddOrUpdateDocuments1 from '/snippets/samples/code_samples_add_or_update_documents_1.mdx';
@@ -23,8 +23,7 @@ The `/documents` route allows you to create, manage, and delete documents.
2323

2424
## Get documents with POST
2525

26-
<RouteHighlighter method="POST" path="/indexes/{index_uid}/documents/fetch
27-
" />
26+
<RouteHighlighter method="POST" path="/indexes/{index_uid}/documents/fetch" />
2827

2928
Get a set of documents.
3029

@@ -106,8 +105,7 @@ Sending an empty payload (`--data-binary '{}'`) will return all documents in the
106105
This endpoint will be deprecated in the near future. Consider using POST `/indexes/{index_uid}/documents/fetch` instead.
107106
</Warning>
108107

109-
<RouteHighlighter method="GET" path="/indexes/{index_uid}/documents
110-
" />
108+
<RouteHighlighter method="GET" path="/indexes/{index_uid}/documents" />
111109

112110
Get a set of documents.
113111

@@ -182,8 +180,7 @@ Using the query parameters `offset` and `limit`, you can browse through all your
182180
```
183181

184182
## Get one document
185-
<RouteHighlighter method="GET" path="/indexes/{index_uid}/documents/{document_id}
186-
" />
183+
<RouteHighlighter method="GET" path="/indexes/{index_uid}/documents/{document_id}" />
187184

188185
Get one document using its unique id.
189186

@@ -218,8 +215,7 @@ Get one document using its unique id.
218215

219216
## Add or replace documents
220217

221-
<RouteHighlighter method="POST" path="/indexes/{index_uid}/documents
222-
" />
218+
<RouteHighlighter method="POST" path="/indexes/{index_uid}/documents" />
223219

224220
Add an array of documents or replace them if they already exist. If the provided index does not exist, it will be created.
225221

@@ -337,8 +333,7 @@ You can use this `taskUid` to get more details on [the status of the task](/refe
337333

338334
## Add or update documents
339335

340-
<RouteHighlighter method="PUT" path="/indexes/{index_uid}/documents
341-
" />
336+
<RouteHighlighter method="PUT" path="/indexes/{index_uid}/documents" />
342337

343338
Add a list of documents or update them if they already exist. If the provided index does not exist, it will be created.
344339

@@ -406,10 +401,9 @@ The documents are matched because they have the same [primary key](/learn/gettin
406401

407402
You can use this `taskUid` to get more details on [the status of the task](/reference/api/tasks#get-one-task).
408403

409-
## Update documents with function (experimental)
404+
## Update documents with function <NoticeTag type="experimental" label="experimental">
410405

411-
<RouteHighlighter method="POST" path="/indexes/{index_uid}/documents/edit
412-
" />
406+
<RouteHighlighter method="POST" path="/indexes/{index_uid}/documents/edit" />
413407

414408
Use a [RHAI function](https://rhai.rs/book/engine/hello-world.html) to edit one or more documents directly in Meilisearch.
415409

@@ -465,8 +459,7 @@ curl \
465459

466460
## Delete all documents
467461

468-
<RouteHighlighter method="DELETE" path="/indexes/{index_uid}/documents
469-
" />
462+
<RouteHighlighter method="DELETE" path="/indexes/{index_uid}/documents" />
470463

471464
Delete all documents in the specified index.
472465

@@ -496,8 +489,7 @@ You can use this `taskUid` to get more details on [the status of the task](/refe
496489

497490
## Delete one document
498491

499-
<RouteHighlighter method="DELETE" path="/indexes/{index_uid}/documents/{document_id}
500-
" />
492+
<RouteHighlighter method="DELETE" path="/indexes/{index_uid}/documents/{document_id}" />
501493

502494
Delete one document based on its unique id.
503495

@@ -528,8 +520,7 @@ You can use this `taskUid` to get more details on [the status of the task](/refe
528520

529521
## Delete documents by filter
530522

531-
<RouteHighlighter method="POST" path="/indexes/{index_uid}/documents/delete
532-
" />
523+
<RouteHighlighter method="POST" path="/indexes/{index_uid}/documents/delete" />
533524

534525
Delete a set of documents based on a filter.
535526

@@ -579,8 +570,7 @@ You can use this `taskUid` to get more details on [the status of the task](/refe
579570
This endpoint will be deprecated in the near future. Consider using POST `/indexes/{index_uid}/documents/delete` instead .
580571
</Warning>
581572

582-
<RouteHighlighter method="POST" path="/indexes/{index_uid}/documents/delete-batch
583-
" />
573+
<RouteHighlighter method="POST" path="/indexes/{index_uid}/documents/delete-batch" />
584574

585575
Delete a set of documents based on an array of document ids.
586576

reference/api/experimental_features.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,7 @@ The experimental API route is not compatible with all experimental features. Con
4040

4141
## Get all experimental features
4242

43-
<RouteHighlighter method="GET" path="/experimental-features
44-
" />
43+
<RouteHighlighter method="GET" path="/experimental-features" />
4544

4645
Get a list of all experimental features that can be activated via the `/experimental-features` route and whether or not they are currently activated.
4746

@@ -63,8 +62,7 @@ Get a list of all experimental features that can be activated via the `/experime
6362

6463
## Configure experimental features
6564

66-
<RouteHighlighter method="PATCH" path="/experimental-features
67-
" />
65+
<RouteHighlighter method="PATCH" path="/experimental-features" />
6866

6967
Activate or deactivate experimental features.
7068

reference/api/facet_search.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ Internally, Meilisearch represents numbers as [`float64`](https://en.wikipedia.o
2121

2222
Search for a facet value within a given facet.
2323

24-
<RouteHighlighter method="POST" path="/indexes/{index_uid}/facet-search
25-
" />
24+
<RouteHighlighter method="POST" path="/indexes/{index_uid}/facet-search" />
2625

2726
<Warning>
2827
This endpoint will not work without first explicitly adding attributes to the [`filterableAttributes`](/reference/api/settings#update-filterable-attributes) list. [Learn more about facets in our dedicated guide.](/learn/filtering_and_sorting/search_with_facet_filters)

reference/api/health.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ The `/health` route allows you to verify the status and availability of a Meilis
1313

1414
## Get health
1515

16-
<RouteHighlighter method="GET" path="/health
17-
" />
16+
<RouteHighlighter method="GET" path="/health" />
1817

1918
Get health of Meilisearch server.
2019

0 commit comments

Comments
 (0)