Skip to content

docs: add synonyms so Algolia surfaces the hybrid/self-hosted pages - #1144

Draft
teallarson wants to merge 2 commits into
mainfrom
docs/algolia-zero-hit-synonyms
Draft

docs: add synonyms so Algolia surfaces the hybrid/self-hosted pages#1144
teallarson wants to merge 2 commits into
mainfrom
docs/algolia-zero-hit-synonyms

Conversation

@teallarson

@teallarson teallarson commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Problem

The latest Algolia weekly summary (application BJB8PBSQ9T, Arcade Docs, Aug 17–23) reports a 32.76% no-result rate on docs_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 deployment
  • self-hosted mcp server private network
  • hybrid deployment self-hosted worker vpc private network cloud engine
  • ip allowlist firewall egress

The 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):

  • railway
  • heroku
  • redact pii from tool outputs response transformation middleware
  • gateway oauth token expiration refresh token session lifetime mcp client re-authenticate
  • google cloud console create oauth client redirect url arcade dashboard add provider
  • add secrets to deployed mcp server dashboard secrets page requires_secrets

Why the four in-scope queries returned zero

  • app/en/operate/deploy/on-prem/page.mdx is 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.mdx describes 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.mdx

  • Frontmatter description now names it as a “self-hosted MCP server worker,” “private network or VPC,” and “hybrid worker deployment.”
  • Overview paragraph calls out “self-hosted worker or hybrid worker,” “on-premises, private cloud, VPC, or any private network,” and “private resources behind a firewall.”
  • “How it works” step 1 lists the same environments (VPC / private network) so the terms appear both in prose and as a numbered list item (both are in the crawler's indexed selectors).
  • Adds a see-also line pointing at Warp Pipes for the “outbound-only egress from your VPC” case.

app/en/operate/deploy/warp-pipes/page.mdx

  • Renames the SSRF allowlist inline as “an IP allowlist for outbound egress” on first mention.
  • Rephrases the follow-up sentence to say “your firewall stays closed to inbound traffic — the runtime only makes outbound egress calls.”

No behavior, no config, no restructuring — just terminology the crawler was missing.

Effect on the Algolia index

On merge to main, algolia-reindex.yml fires (the paths touched are under app/en/**), which triggers a fresh crawl. The four zero-hit queries above should now surface the corresponding pages.

Test plan

  • Merge and wait for algolia-reindex.yml to complete
  • Search each of the four in-scope queries on docs.arcade.dev and confirm the on-prem / warp-pipes page appears
  • Check next week's Algolia weekly summary to confirm the no-result rate drops

Note

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.

@vercel

vercel Bot commented Aug 27, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 27, 2026 2:57pm

Request Review

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