Skip to content

docs: fix broken cross-page anchor links - #3728

Open
SatvikMishra08 wants to merge 1 commit into
meilisearch:mainfrom
SatvikMishra08:docs-fix-broken-anchors
Open

SatvikMishra08 wants to merge 1 commit into
meilisearch:mainfrom
SatvikMishra08:docs-fix-broken-anchors

Conversation

@SatvikMishra08

@SatvikMishra08 SatvikMishra08 commented Oct 12, 2026 •

Copy link
Copy Markdown

Fixes a handful of cross-page links that pointed at renamed sections or pages that were split out when the docs were reorganized:

  • Geo _geo setup: #preparing-documents-for-location-based-search → #add-_geo-to-your-documents
  • Searchable attributes links that still pointed at the displayed-attributes page → configure_searchable_attributes
  • Documents add/replace and add/update anchors → their own API pages
  • Task status link → async-task-management/get-task
  • FAQ hardware requirements + SDKs frameworks section renamed anchors

All targets checked against the live docs.

Summary by CodeRabbit

  • Documentation
    • Updated links across search, indexing, API, error-code, and self-hosting guidance to point to the relevant current documentation pages.
    • Corrected links for geographic filtering, searchable and displayed attributes, framework integrations, document endpoints, and task status.

Update links that pointed at renamed sections or pages that were
split out of the old combined docs (geo _geo setup, searchable vs
displayed attributes, documents/tasks API pages, FAQ, SDKs).
@coderabbitai

coderabbitai Bot commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 6854632c-fe11-411d-a964-2b643adf3ec2

📥 Commits

Reviewing files that changed from the base of the PR and between 85f2962 and 8741e83.


📒 Files selected for processing (8)
  • capabilities/filtering_sorting_faceting/advanced/filter_expression_syntax.mdx
  • capabilities/full_text_search/relevancy/attribute_ranking_order.mdx
  • capabilities/indexing/advanced/indexing_best_practices.mdx
  • getting_started/features.mdx
  • reference/api/headers.mdx
  • reference/api/requests.mdx
  • reference/errors/error_codes.mdx
  • resources/internals/documents.mdx

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.



📝 Walkthrough

Walkthrough

This PR updates documentation links in eight pages. The new targets point to current guides, API reference pages, and FAQ sections. Surrounding descriptions and guidance remain unchanged.

Changes

Documentation link updates

Layer / File(s) Summary
Update documentation link destinations
capabilities/filtering_sorting_faceting/advanced/filter_expression_syntax.mdx, capabilities/full_text_search/relevancy/attribute_ranking_order.mdx, capabilities/indexing/advanced/indexing_best_practices.mdx, getting_started/features.mdx, reference/api/headers.mdx, reference/api/requests.mdx, reference/errors/error_codes.mdx, resources/internals/documents.mdx
Updated links point to current guide, API reference, and FAQ destinations. The surrounding descriptions and guidance are unchanged.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Suggested reviewers: qdequele


Merge Risk: ⚪ Minimal · up to 8741e

The updated links lead to existing, relevant documentation destinations. No material navigation issue remains, so this PR is ready to merge after normal checks.

Architecture Summary

Architecture risk: 🔵 Low · up to 8741e

The change affects 4 systems.

Changed systems: capabilities, reference, getting_started, resources

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — capabilities (service) was modified; 3 changed files map to changed impact.
  • observed — reference (api) was modified; 3 changed files map to changed impact.
  • observed — getting_started (service) was modified; 1 changed file maps to changed impact.
  • observed — resources (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in capabilities/filtering_sorting_faceting/advanced/filter_expression_syntax.mdx: Updated the _geo documentation link target from “Preparing documents for location-based search” to “Add _geo to your documents”; the surrounding filtering guidance is unchanged.
  • observed — Modified behavior in capabilities/full_text_search/relevancy/attribute_ranking_order.mdx: The link to configure the searchable attributes list now targets the dedicated configure_searchable_attributes page instead of the searchable-attributes section of configure_displayed_attributes.
  • observed — Modified behavior in capabilities/indexing/advanced/indexing_best_practices.mdx: Updated the searchable-attributes link destination from the full-text-search guide’s “searchable fields” anchor to the reference API documentation.
  • observed — Modified behavior in getting_started/features.mdx: The Frameworks link now points to /resources/help/sdks#framework-sdks instead of /resources/help/sdks#framework-integrations; its description is unchanged.

Pre-merge checks | Passed 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 and concisely describes the primary change: fixing broken cross-page documentation anchor links.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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 a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

This branch has not been deployed

No deployments
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