Skip to content

Comments

spike(search): MiniSearch-backed custom docs content in header search#2158

Draft
thorthelegend99 wants to merge 1 commit intoevent-catalog:mainfrom
thorthelegend99:spike/minisearch-custom-docs-search
Draft

spike(search): MiniSearch-backed custom docs content in header search#2158
thorthelegend99 wants to merge 1 commit intoevent-catalog:mainfrom
thorthelegend99:spike/minisearch-custom-docs-search

Conversation

@thorthelegend99
Copy link
Contributor

Summary

Spike: add custom docs content search using MiniSearch while preserving existing fast header search behavior.

What this changes

  • adds a new API endpoint: /api/search-docs-index.json
    • indexes customPages + pages content
    • strips markdown and caps content size per entry for payload control
  • keeps existing /api/search-index.json behavior for resource metadata search
  • updates header search modal to:
    • lazy-load docs index only after user starts typing
    • run MiniSearch client-side against docs content
    • merge docs matches into existing header search results (Doc result type)

UX

  • Search remains in the same header modal.
  • No extra route required; docs content results show alongside normal results.

Perf notes

  • two-index strategy (metadata + docs content)
  • docs index lazy-loaded on intent (query length >= 2)
  • content is pre-trimmed to avoid huge payloads

Status

  • Spike / draft for discussion, ranking tuning, and payload thresholds.

Validation

  • pnpm --filter @eventcatalog/core check

@changeset-bot
Copy link

changeset-bot bot commented Feb 16, 2026

⚠️ No Changeset found

Latest commit: ec5bef3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@CLAassistant
Copy link

CLAassistant commented Feb 16, 2026

CLA assistant check
All committers have signed the CLA.

@thorthelegend99 thorthelegend99 force-pushed the spike/minisearch-custom-docs-search branch from 88250e3 to ec5bef3 Compare February 17, 2026 22:21
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.

2 participants