Skip to content

Update outdated documentation links#719

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

Update outdated documentation links#719
qdequele wants to merge 2 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

  • Documentation
    • Updated all documentation links throughout the project to align with the current Meilisearch documentation structure. Changes include redirecting FAQ resources, async task management endpoints, and search parameter configuration guides to their latest documentation paths, ensuring users access current, accurate, and properly organized information.

@coderabbitai
Copy link
Copy Markdown

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: 35c040f7-515b-4e6b-8ddc-3cd1ed0c0666

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

The pull request updates documentation references across the codebase. README.md links are revised to point to newer Meilisearch documentation paths for FAQ, task management, and search parameters. An XML documentation comment in MeilisearchClient.cs is similarly updated to reflect current documentation structure.

Changes

Cohort / File(s) Summary
Documentation Links
README.md
Updated multiple documentation URLs: FAQ link to /docs/learn/resources/faq, task status references to "list tasks" endpoints, and search-parameter references to search-with-post sections.
XML Documentation Comment
src/Meilisearch/MeilisearchClient.cs
Updated GetVersionAsync method documentation URL from "get-version-of-meilisearch" to "version/get-version#get-version-of-meilisearch" path.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰✨ Links were old, now they shine so bright,
Documentation paths aligned just right,
No code was changed, just breadcrumbs laid,
To guide the seekers through the upgrade's glade!

🚥 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 'Update outdated documentation links' directly and accurately summarizes the main change: updating documentation URLs in README.md and MeilisearchClient.cs to point to current documentation paths.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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