meilisearch / meilisearch/documentation

Fix the 5 broken internal links reported in broken-links.txt

Open
#3,674 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

fix/improvement
Dominant language
MDX
Stars
174
Forks
276
Avg merge
2d 1h
Merged PRs (30d)
6

Description

Follow-up to #3672.

broken-links.txt at the repo root currently reports 5 broken internal links across 4 files, all pointing to pages that do not exist:

  • capabilities/full_text_search/advanced/debug_search_performance.mdx line 98: /resources/self_hosting/sharding
  • capabilities/indexing/how_to/document_relations.mdx line 142: /resources/self_hosting/sharding
  • capabilities/indexing/how_to/document_relations.mdx line 148: /reference/api/settings/get-foreign-keys
  • resources/help/experimental_features_overview.mdx line 69: /capabilities/personalization/getting_started
  • resources/self_hosting/enterprise_edition.mdx line 14: /resources/self_hosting/sharding

Beyond the reader-facing dead ends, broken internal links slow down crawler re-mapping of the site after the IA restructures, which matters while we are trying to recover the docs' search positions (see #3672).

Fix is either creating the missing target pages (the sharding page is referenced from 3 places, so it probably should exist) or repointing the links to existing pages.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with broken-links.txt and inspect the five links in the four listed .mdx files, then check whether existing documentation can replace the missing targets or whether new pages are needed. Re-run the broken-link check and confirm all five internal links resolve without reader-facing dead ends.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.