[mkdocs] Search is slow
オープン
まだ誰も着手していません。
P1
performance
- 主要言語
- Python
- スター
- 18.8k
- フォーク
- 2.8k
- 平均マージ
- 16時間 26分
- マージ済み PR(30日)
- 21
説明
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.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
ファイル、テスト、エントリーポイントは指定されていません。まず MkDocs の検索設定を確認し、issue で説明されている既存の Algolia ベースの検索と比較します。より高速な検索アプローチを選択して実装し、最初の検索で期待される応答性で結果が返されることを確認できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- documentation, search
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100