Skip to content

Update outdated documentation links#1218

Draft
qdequele wants to merge 4 commits intomainfrom
fix/update-documentation-links
Draft

Update outdated documentation links#1218
qdequele wants to merge 4 commits intomainfrom
fix/update-documentation-links

Conversation

@qdequele
Copy link
Copy Markdown
Member

@qdequele qdequele commented Mar 20, 2026

Summary

  • Updated meilisearch.com/docs links to match the current sitemap URLs
  • Old paths were either redirecting (308) or returning 404s

Test plan

  • Verify all updated links resolve correctly (no 404s or extra redirects)
  • No code logic changed — only documentation URLs

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated documentation references and links throughout the Python SDK to align with current Meilisearch API documentation endpoints. Changes include FAQ resources, task management references, search parameter documentation, API key and webhook documentation, backup and export endpoints, and network configuration resources. These updates ensure developers accessing the SDK have access to the most current and specific API guidance.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 20, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 59fc0925-9202-4125-8ab9-e0a5bbcb0cf4

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Documentation reference URLs across the Python client library and README were updated to point to more specific Meilisearch API documentation endpoints. Task management, search, indexes, settings, API keys, webhooks, and backup routes were revised to use updated documentation paths. No code logic or function signatures were modified.

Changes

Cohort / File(s) Summary
Documentation Links
README.md
Updated FAQ and API reference links to point to self-hosted getting-started, async task management, search-with-post, and specific endpoint documentation pages.
Client API Docstrings
meilisearch/client.py, meilisearch/index.py, meilisearch/task.py
Updated docstring URLs across task-related methods, search endpoints, stats, API keys, webhooks, backups, exports, and network configuration to reference more specific async-task-management, search-with-post, and endpoint-specific documentation routes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 Hoppity links, now pointing true,
Documentation paths all brand new,
From tasks to searches, settings in sight,
Every reference now shines oh-so-bright!
No logic changed, just URLs to chase—
A tidy update at a rapid pace! 🔗✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: updating outdated documentation links across multiple files in the codebase.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/update-documentation-links

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 and usage tips.

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.

1 participant