[mkdocs] Search is slow

Open
#5,397 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

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.

Description

P1 performance

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.

Dominant language
Python
Stars
18.8k
Forks
2.8k
Avg merge
13h 41m
Merged PRs (30d)
21

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from plotly/plotly.py

All issues in plotly/plotly.py

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.