HeyPuter/puter

Docs search improvement

Open

#2362 opened on Jan 28, 2026

View on GitHub
 (8 comments) (0 reactions) (0 assignees)JavaScript (41,281 stars) (3,752 forks)batch import
enhancementhelp wanted

Description

Currently our search feature in docs uses basic text matching. While this works, it has downsides such as it can't match similar word, and also handle some level of typos

https://docs.puter.com/

ideally the search would be something like this:

  • supports fuzzy search, we can simply use a library like pagefind, or similar for this (whichever works best)
  • still maintain our text fragment matching, this is unique to puter docs
  • if it's not an exact match (fuzzy) we still want the search result to jump somewhere, and the way it's done is to jump to the nearest subheading

Contributor guide

Tech stack
javascripthtmlcss
Domain
documentationsearch
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScript proficiencyHTML and CSSUnderstanding of fragment matching
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate the current search implementation in the docs directory (likely in JavaScript files). Review the text fragment matching logic used in the existing search. Research the pagefind library for integration and understand how to combine fuzzy search with existing fragment matching. Check the comments in the issue for any additional requirements or proposed solutions.