docs: add synonyms so Algolia surfaces the hybrid/self-hosted pages - #1144
Draft
teallarson wants to merge 2 commits into
Draft
docs: add synonyms so Algolia surfaces the hybrid/self-hosted pages#1144teallarson wants to merge 2 commits into
teallarson wants to merge 2 commits into
Conversation
…yms so Algolia surfaces the page
…golia surfaces the page
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
teallarson
marked this pull request as draft
August 27, 2026 15:18
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The latest Algolia weekly summary (application
BJB8PBSQ9T, Arcade Docs, Aug 17–23) reports a 32.76% no-result rate ondocs_arcade_dev_bjb8pbsq9t_docsearch. Several of the zero-hit queries point at pages that already exist in this repo but use different words than the users typing them.Zero-result search queries in scope
From the Algolia “Searches with no results” list:
hybrid worker deploymentself-hosted mcp server private networkhybrid deployment self-hosted worker vpc private network cloud engineip allowlist firewall egressThe rest of the report's zero-hit list (kept here for context, not addressed by this PR because they're real content gaps rather than terminology mismatches):
railwayherokuredact pii from tool outputs response transformation middlewaregateway oauth token expiration refresh token session lifetime mcp client re-authenticategoogle cloud console create oauth client redirect url arcade dashboard add provideradd secrets to deployed mcp server dashboard secrets page requires_secretsWhy the four in-scope queries returned zero
app/en/operate/deploy/on-prem/page.mdxis titled Hybrid MCP servers, but the body only ever uses “on-premises.” The words worker, self-hosted, hybrid worker, VPC, private network, and firewall never appear on the page, so Algolia can't match them.app/en/operate/deploy/warp-pipes/page.mdxdescribes the SSRF allowlist and outbound connections, but never uses IP allowlist, firewall, or egress — the exact wording of the user query.Fix
Add the missing synonyms naturally into the prose of both pages so the crawler indexes them without changing meaning or introducing new concepts.
app/en/operate/deploy/on-prem/page.mdxapp/en/operate/deploy/warp-pipes/page.mdxNo behavior, no config, no restructuring — just terminology the crawler was missing.
Effect on the Algolia index
On merge to
main,algolia-reindex.ymlfires (the paths touched are underapp/en/**), which triggers a fresh crawl. The four zero-hit queries above should now surface the corresponding pages.Test plan
algolia-reindex.ymlto completedocs.arcade.devand confirm the on-prem / warp-pipes page appearsNote
Low Risk
Documentation-only wording and link updates; no runtime, config, or application code changes.
Overview
Updates Hybrid MCP servers (
on-prem/page.mdx) and Warp Pipes (warp-pipes/page.mdx) so doc search can match how users phrase hybrid/self-hosted and network egress topics—no product or config changes.On the hybrid page, the meta description and body now use terms like self-hosted worker, hybrid worker, VPC, private network, and firewall, and registration is described as registering a worker. A short cross-link points readers who want outbound-only egress (no tunnel) to Warp Pipes. The info Callout that contrasted Arcade vs Remote MCP server registration was removed, and dashboard links were updated to
api.arcade.dev/dashboard/....On Warp Pipes, the SSRF allowlist is introduced inline as an IP allowlist for outbound egress, and the internal-MCP section clarifies that the firewall stays closed to inbound traffic while the runtime makes outbound egress calls.
Reviewed by Cursor Bugbot for commit a447cd2. Bugbot is set up for automated code reviews on this repo. Configure here.