Merge pull request #3541 from meilisearch/ci-check-missing-redirects

Add CI workflow to check missing redirects on PRs

Author: qdequele

.github/workflows/check-broken-links.yml

@@ -0,0 +1,28 @@
+# Runs on every PR targeting main and on workflow_dispatch.
+# Checks for broken internal links in MDX documentation files.
+# No secrets required — runs entirely from local files.
+name: Check broken links
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  check-broken-links:
+    name: Check broken links
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Check broken internal links
+        run: npm run check-broken-links

.github/workflows/check-missing-redirects.yml

@@ -0,0 +1,32 @@
+# Runs on PRs targeting main and on workflow_dispatch.
+# Checks for missing redirects (URLs with traffic but no page or redirect)
+# and unused redirects (redirects with zero traffic) using Fathom Analytics data.
+name: Check missing redirects
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  check-missing-redirects:
+    name: Check missing redirects
+    runs-on: ubuntu-latest
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-node@v6
+        with:
+          node-version: "20"
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Check missing redirects
+        env:
+          FATHOM_API_KEY: ${{ secrets.FATHOM_API_KEY }}
+          FATHOM_SITE_ID: ${{ secrets.FATHOM_SITE_ID }}
+        run: npm run check-missing-redirects

.gitignore

@@ -139,3 +139,4 @@ yarn-error.log
 
 # Script output
 missing-redirects.txt
+broken-links.txt

capabilities/conversational_search/getting_started/setup.mdx

@@ -17,7 +17,7 @@ Enable chat completions from your Meilisearch Cloud project in one of two ways:
 - Or open the **Chat** tab in your project and activate the feature directly from there
 
 <Note>
-For self-hosted instances, enable the feature through the [experimental features API](/reference/api/experimental-features/update-experimental-features).
+For self-hosted instances, enable the feature through the [experimental features API](/reference/api/experimental-features/configure-experimental-features).
 </Note>
 
 ## Find your chat API key
@@ -36,7 +36,7 @@ If your instance does not have a Default Chat API Key, create one manually:
 
 ## Configure your indexes
 
-Configure the [chat settings](/reference/api/chat-settings/update-index-chat-settings) for each index you want to make available to the conversational search agent:
+Configure the [chat settings](/reference/api/chats/update-settings-of-a-chat-workspace) for each index you want to make available to the conversational search agent:
 
 <CodeGroup>
 

capabilities/full_text_search/advanced/debug_search_performance.mdx

@@ -95,7 +95,7 @@ When using `showPerformanceDetails` at the `federation` level, you see these sta
 | Stage | Description |
 |-------|-------------|
 | `federating results > partition queries` | Organizing queries by index and remote host. |
-| `federating results > start remote search` | Initiating search requests to remote Meilisearch instances. Only appears when using [network search](/resources/self_hosting/sharding). |
+| `federating results > start remote search` | Initiating search requests to remote Meilisearch instances. Only appears when using [network search](/resources/self_hosting/sharding/overview). |
 | `federating results > execute local search` | Executing queries against local indexes. |
 | `federating results > wait for remote results` | Waiting for remote instances to respond. High values indicate network latency or slow remote instances. |
 | `federating results > merge results` | Merging and deduplicating results from all sources into a single ranked list. |

capabilities/indexing/how_to/document_relations.mdx

@@ -139,13 +139,13 @@ With foreign keys configured, the same result is automatically hydrated:
 ## Limitations
 
 - **Experimental**: This feature may change or be removed in future versions.
-- **No remote [sharding](/resources/self_hosting/sharding)**: Foreign keys are not supported in environments using remote sharding.
+- **No remote [sharding](/resources/self_hosting/sharding/overview)**: Foreign keys are not supported in environments using remote sharding.
 - **One direction**: Hydration works from the main index to the referenced index. The referenced index does not automatically link back.
 
 ## Next steps
 
 <CardGroup cols={2}>
-  <Card title="Foreign keys settings API" href="/reference/api/settings/get-foreign-keys">
+  <Card title="Foreign keys settings API" href="/reference/api/settings/get-foreignkeys">
     Full API reference for foreign key settings
   </Card>
   <Card title="Experimental features API" href="/reference/api/experimental-features/list-experimental-features">