Skip to content

Update sharding feature compatibility page - #3650

Open
ManyTheFish wants to merge 1 commit into
mainfrom
update-sharding-documentation
Open

Update sharding feature compatibility page#3650
ManyTheFish wants to merge 1 commit into
mainfrom
update-sharding-documentation

Conversation

@ManyTheFish

@ManyTheFish ManyTheFish commented Aug 10, 2026

Copy link
Copy Markdown
Member

Explicitly add the support of the Foreign filters, the hydration, and the fetching of documents.

Description

Checklist

For internal Meilisearch team member only:

For external maintainers

  • Did you use any AI tool while implementing this PR (code, tests, docs, etc.)? If yes, disclose it in the PR description and describe what it was used for. AI usage is allowed when it is disclosed.
  • Have you made sure that the title is accurate and descriptive of the changes?

Summary by CodeRabbit

  • Documentation
    • Updated the feature compatibility table to include foreign filtering and hydration.
    • Documented cross-remote document fetching with useNetwork support.

Explicitly add the support of the Foreign filters, the hydration, and the fetching of documents.
@mintlify

mintlify Bot commented Aug 10, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
meilisearch-documentation 🟢 Ready View Preview Aug 10, 2026, 11:38 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The sharding compatibility table now documents foreign filtering, hydration, and network-enabled document fetching through POST /documents/fetch.

Changes

Sharding compatibility

Layer / File(s) Summary
Update compatibility table
resources/self_hosting/sharding/overview.mdx
The table documents foreign filtering, hydration, and useNetwork support for POST /documents/fetch.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

Poem

A rabbit reads the table with care,
New sharding facts now nestle there.
Foreign filters, hydration too,
Network fetches join the queue.
Hop, hop—clear docs for all to view!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the update to the sharding feature compatibility page, which matches the documented changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update-sharding-documentation

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@resources/self_hosting/sharding/overview.mdx`:
- Line 123: Update the “Documents fetch” table entry to use the full
index-scoped endpoint path, POST /indexes/{index_uid}/documents/fetch, while
preserving the existing useNetwork description.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 4842fe4c-0dff-4075-bcaf-8b49bf938d51

📥 Commits

Reviewing files that changed from the base of the PR and between f4f9212 and 160837c.

📒 Files selected for processing (1)
  • resources/self_hosting/sharding/overview.mdx

| Filtering and sorting | Yes | Filters applied on each remote before merging |
| Foreign filtering and hydration | Yes | Foreign documents will be retrieved from each remote |
| Faceted search | Yes | Facet distribution in search results works across remotes, and the `/facet-search` endpoint supports `useNetwork` |
| Documents fetch | Yes | Documents fetch works across remotes, and the `POST /documents/fetch` endpoint supports `useNetwork` |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win

Use the full index-scoped document-fetch path.

Line 123 lists POST /documents/fetch, but the canonical guide defines the endpoint as POST /indexes/{index_uid}/documents/fetch. The shortened path can send users to an invalid route. Update this table entry.

The canonical guide at capabilities/indexing/how_to/add_and_update_documents.mdx:192-223 uses the full path.

Proposed fix
-| Documents fetch | Yes | Documents fetch works across remotes, and the `POST /documents/fetch` endpoint supports `useNetwork` |
+| Documents fetch | Yes | Documents fetch works across remotes, and the `POST /indexes/{index_uid}/documents/fetch` endpoint supports `useNetwork` |
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
| Documents fetch | Yes | Documents fetch works across remotes, and the `POST /documents/fetch` endpoint supports `useNetwork` |
| Documents fetch | Yes | Documents fetch works across remotes, and the `POST /indexes/{index_uid}/documents/fetch` endpoint supports `useNetwork` |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@resources/self_hosting/sharding/overview.mdx` at line 123, Update the
“Documents fetch” table entry to use the full index-scoped endpoint path, POST
/indexes/{index_uid}/documents/fetch, while preserving the existing useNetwork
description.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants