Hey all,

tl;dr: Visit https://airflow.staged.apache.org/docs/apache-airflow/3.1.5/,
press Cmd+K (or Ctrl+K), and try the new search experience.

Now details :D

After implementing dark mode to solve one of my frustrations
and modernizing deps on airflow-site, I went on the journey to improve
(have an alternate) search experience on Airflow docs. I really hate the
Sphinx search -- it is slow and often returns irrelevant results.

Similar GH issue created 3 years ago:
https://github.com/apache/airflow-site/issues/666

I am happy to share that https://github.com/apache/airflow/pull/59658
introduces a modern, fast, client-side search powered by Pagefind (
https://pagefind.app/).

Preview is available on our staging site:
https://airflow.staged.apache.org/docs/apache-airflow/3.1.5/

Visit it, and press cmd+K and try it out.

Key improvements:

   - Instant search: Results appear as you type with no server round-trips
   - Better relevance: Better title matches rank
   - Cleaner results: Auto-generated API docs and internal pages are
   excluded
   - Keyboard navigation: Full keyboard support with Cmd+K/Ctrl+K shortcut
   - Modern UI: Custom-built modal with our own CSS/JS
   - Privacy-friendly: All search happens client-side, no external services

The PR is ready for review. Once merged, I'll deploy it to production.
Documentation for the Sphinx extension is included in the PR.

I'd appreciate feedback and reviews! After spending considerable time on
the JS, CSS, and search tuning, I'm confident this will significantly
improve our users' documentation experience.

Happy Holidays. 🎄

Regards,
Kaxil

Reply via email to