Skip to content

upstash/search-docs

Repository files navigation

Deploy with Vercel

Description

A modern documentation library to search and track the docs.

Getting Started

First, run the development server:

npm install
npm run dev

How it Works

  • Search: Uses Upstash Search UI to query multiple indexes in parallel, sorts and groups results, and displays them with section headers.
  • Recent Updates: Upstash Qstash fetches all documents from multiple indexes in batches, filters for those crawled in the last 24 hours.

Set the Crawler

  • Upstash Qstash can call this endpoint: /api/crawl on schedule to crawl the relevant data
  • Providing the URL and the index name in the body, you may manage the crawler, e.g.
{
    "docsUrl": "https://nextjs.org/docs",
    "index": "next-js"
}

Conclusion

Finally, the UI will make use of these components to serve users to find whatever they want from any source they want. Moreover, they can keep up with the updates in their favorite docs.

About

A modern documentation library to search and track the docs.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages