Skip to content

fix/site: Search results link to current instance - #1875

Merged
marcleblanc2 merged 1 commit into
mainfrom
search-results-relative-urls
Sep 11, 2026
Merged

fix/site: Search results link to current instance#1875
marcleblanc2 merged 1 commit into
mainfrom
search-results-relative-urls

Conversation

@marcleblanc2

@marcleblanc2 marcleblanc2 commented Sep 8, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Problem

On a Vercel preview deployment (or local dev), searching for something, then clicking on a search result always takes you to https://sourcegraph.com/docs/... instead of the matching page on the deployment you're viewing.

Cause: the Algolia crawler indexes prod, so every hit's url is an absolute prod URL. The vendored DocSearch renders it verbatim in Hit.tsx (<a href={hit.url}>) and returns it from getItemUrl (Enter-key navigation), so nothing ever makes it relative to the current origin.

Fix

Pass a transformItems to DocSearch in src/components/search/Search.tsx that rewrites https://sourcegraph.com/docs/<path> → ${NEXT_PUBLIC_DOCS_BASE_PATH}/<path>. NEXT_PUBLIC_DOCS_BASE_PATH is already /docs in production and '' elsewhere (see next.config.js), so:

  • prod: /docs/batch-changes/view-batch-changes#viewing-batch-changes (same target as today)
  • preview / local: /batch-changes/view-batch-changes#viewing-batch-changes, resolved against the current origin

transformItems runs before saveRecentSearch, so recent/favorite searches persisted in localStorage get the rewritten URL too. URLs that don't start with the prod prefix are left untouched.

Not changed

  • Index content: results still reflect what the crawler last saw on prod. Pages added/renamed only in a PR won't show up in search (or may 404 on the preview). Only the link target is localized.
  • No Algolia/crawler config changes.

Verification

Tested on the preview deployment https://sourcegraph-docs-c9sonegt9-sourcegraph-f8c71130.vercel.app:

  • Searched "batch changes"; result anchors render with relative hrefs that resolve to the preview origin, e.g. /batch-changes/view-batch-changes#viewing-batch-changes → https://sourcegraph-docs-c9sonegt9-sourcegraph-f8c71130.vercel.app/batch-changes/view-batch-changes#viewing-batch-changes.
  • Pressing Enter on the first result navigated to that preview URL (page title "Viewing Batch Changes - Sourcegraph docs", <h1> "Viewing Batch Changes"), not to sourcegraph.com/docs.
  • Recent-searches localStorage entry stored the relative URL /batch-changes/view-batch-changes#viewing-batch-changes.

Production behavior (/docs/<path> prefix) is unchanged

Amp threads

@vercel

vercel Bot commented Sep 8, 2026 •
edited
Loading

Copy link
Copy Markdown

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

Project Deployment Actions Updated
sourcegraph-docs Ready Ready Preview Sep 11, 2026 1:19am UTC

Request Review

@marcleblanc2 marcleblanc2 changed the title Search: send results to the current deployment instead of prod Search: send results to the current deployment instead of always assuming prod Sep 8, 2026
@marcleblanc2
marcleblanc2 marked this pull request as ready for review September 8, 2026 01:35
@marcleblanc2 marcleblanc2 changed the title Search: send results to the current deployment instead of always assuming prod Search: Send results to the current deployment instead of always assuming prod Sep 9, 2026
@marcleblanc2 marcleblanc2 changed the title Search: Send results to the current deployment instead of always assuming prod fix/site: Send search results to the current deployment instead of always assuming prod Sep 9, 2026
@marcleblanc2 marcleblanc2 changed the title fix/site: Send search results to the current deployment instead of always assuming prod fix/site: Link search results to current site instead of assuming prod Sep 9, 2026
@marcleblanc2 marcleblanc2 mentioned this pull request Sep 10, 2026
Merged
@marcleblanc2 marcleblanc2 changed the title fix/site: Link search results to current site instead of assuming prod fix/site: Search results link to current instance Sep 10, 2026
@marcleblanc2
marcleblanc2 requested a review from a team September 10, 2026 00:50
@marcleblanc2
marcleblanc2 enabled auto-merge (squash) September 10, 2026 00:50
marcleblanc2 added a commit that referenced this pull request Sep 11, 2026
@marcleblanc2 @ampagent
ci/dev: Add direct links to changed pages in Vercel previews (#1874)
8df616f 
## Problem

- Vercel bot's build preview comment on every docs PR links to the
**root** (home page) of the preview deployment
- When your PR changes only one page, you still have to click through
the preview site to find it (search to be fixed in PR #1875)
- Vercel has no setting to link directly at your changed page

## Solution

- Adding our own PR comment with links to the pages your PR changes, as
shown here
#1891 (comment)

## Decisions made, and can be changed

- Link list length capped at 40 pages
- Deleted files are excluded
- Renamed files link to the new path
- PRs that change no `docs/` pages get no comment

## Amp threads

- [Vercel preview page
links](https://ampcode.com/threads/T-01a07e6e-2b53-73cb-be1c-faaf2308d033)
- [Address PR 1874
feedback](https://ampcode.com/threads/T-01a08573-3d6c-7491-ac34-61b4800612a8)

---------

Co-authored-by: Amp <amp@ampcode.com>
@marcleblanc2 @ampagent
Search: rewrite Algolia hit URLs to the current deployment
46a88b8 
The Algolia crawler indexes production, so every hit URL is absolute
(https://sourcegraph.com/docs/...). DocSearch rendered those verbatim,
so selecting a result on a Vercel preview (or local dev) always jumped
to prod.

Pass a transformItems to DocSearch that strips the prod prefix and
prepends NEXT_PUBLIC_DOCS_BASE_PATH, so hrefs resolve against the
deployment being viewed: /docs/<path> in prod, /<path> on previews.

Co-authored-by: Amp <amp@ampcode.com>
Amp-Thread-ID: https://ampcode.com/threads/T-01a07e6c-cddd-72b1-b3bf-98ad32f9d55a
@marcleblanc2
marcleblanc2 force-pushed the search-results-relative-urls branch from 880e095 to 46a88b8 Compare September 11, 2026 01:17
@marcleblanc2
marcleblanc2 merged commit ff52e71 into main Sep 11, 2026
2 checks passed
@marcleblanc2
marcleblanc2 deleted the search-results-relative-urls branch September 11, 2026 01:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pjlast pjlast pjlast approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@marcleblanc2 @pjlast