[mkdocs] Search is slow
Open
Nobody has claimed this yet.
P1
performance
- Dominant language
- Python
- Stars
- 18.8k
- Forks
- 2.8k
- Avg merge
- 16h 26m
- Merged PRs (30d)
- 21
Description
Probably because there are so many pages. The first time you search it can take a few seconds for any results to appear, compared with our existing search, which is instant.
Might need to look at solutions beyond the mkdocs built-in search. Our current docs use Algolia, so maybe we can build that in.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. Start by reviewing the MkDocs search configuration and comparing it with the existing Algolia-based search described in the issue. Done means selecting and implementing a faster search approach, then confirming that the first search returns results with the expected responsiveness.
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