Add search using Typesense

[rafaeluphold]

Description

Added search to the documentation using Typesense.

How it works: The search bar is registered as a Docusaurus theme and appears automatically in the navigation bar. A scraper crawls the built website and indexes the content into Typesense. On every master deploy, the CI rebuilds and re-indexes automatically.

Requirements: A Typesense instance needs to be provisioned and the following three secrets added to the repository.

TYPESENSE_HOST
TYPESENSE_API_KEY - admin key, used by the scraper
TYPESENSE_SEARCH_API_KEY - read-only key, used by the browser

Hosting options: A decision needs to be made regarding the hosting of this service.

• Typesense Cloud - managed, free tier is 720 hours/10GB one-time, then ~$25/month;

• Self-hosted - deploy Typesense into an existing Uphold server, which requires Docker and an open port.

Related Issues

SWY-482

Screenshots

Screen.Recording.2026-04-01.at.17.20.57.mov

[Copilot]

Pull request overview

Adds Typesense-powered search to the Topper docs site by integrating the Docusaurus Typesense theme and wiring CI to re-index content after deployments.

Changes:

• Add Typesense DocSearch configuration and local env sample.
• Integrate docusaurus-theme-search-typesense and Typesense config into Docusaurus.
• Extend the deploy workflow to run the Typesense scraper on master.

Reviewed changes

Copilot reviewed 6 out of 8 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
typesense-docsearch-config.json	Adds the Typesense DocSearch scraper configuration (index name, sitemap/start URLs, selectors).
package.json	Updates Docusaurus versions, adds the Typesense theme dependency, and introduces scripts for running Typesense + indexing via the scraper container.
docusaurus.config.js	Configures the Typesense search theme and reads Typesense connection details from env vars.
.github/workflows/deploy.docusaurus.yml	Runs indexing on master after deploying to Cloudflare Pages and injects env vars for build/index.
.env.typesense.sample	Documents expected Typesense env vars for local/Typesense Cloud usage.
.gitignore	Ignores local Typesense env file and Typesense data directory.
README.md	Minor wording/capitalization updates.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[github-actions]

🚀 Preview has been deployed.

Name	Link
🔨 Commit SHA	50e9acc
🔍 Deploy Log	https://github.com/uphold/topper-docs/actions/runs/23898945478
🚀 Preview URL	https://9a7017d7.topper-docs.pages.dev