getodk / getodk/docs

Improve search

Open
#1,637 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

The default search is not very good.

One idea is to try Google Search instead: https://www.sphinx-doc.org/en/master/faq.html
* @sadiqkhoja tried in https://github.com/getodk/docs/pull/1667 and it resulted in a whole page of ads before relevant results 🤯
* Paid results are $5/1000 queries!

Contributor guide

Open the contributing guide

Research direction

No file or test is named in the issue. Review the Sphinx FAQ and the results from pull request #1667 first, then define an acceptable search approach and how its result quality and advertising behavior will be evaluated.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, search
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.