Add search

オープン
  • 何か問題がありますか？
#292 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
javascript
領域
documentation, search, web-dev

調査の方向性

Start by reviewing the docsite redesign and the generated _site output, then evaluate how elasticlunr could index the

, <title>, and <h*> content. Define the search-result presentation and keyboard behavior from the examples mentioned, including how API functions should be weighted. Done means the docsite has a usable custom search without the removed DuckDuckGo bar.

索引モデルが issue の本文から書いたものです。

説明

enhancement

In the docsite redesign we removed the duckduckgo search bar. The plan is to replace it with a custom search bar.

Current ideas for this are roughly

  • use something like elasticlunr
  • produce an index by scanning the generated _site, focussing the search on the <main>, <title>, and <h*> tags with more weight on <h*> and <title>
  • it would be nice to recognise API functions and give them more weight so that it is possible to go to them quickly. Not sure how much work that would be.
  • write js to present search results in a reasonably nice form (examples would be mdbook or the search on the tailwindcss.com site)
  • make sure search can be operated by keyboard without mouse
主要言語
HTML
スター
19
フォーク
67
平均マージ
21時間 12分
マージ済み PR（30日）
4

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

seL4/docs のほかの issue

seL4/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。