solidjs / solidjs/solid-docs

[Bug]: Search feature misses important results

オープン
#1,314 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

bug planned site improvement
主要言語
MDX
スター
292
フォーク
361
平均マージ
7時間 51分
マージ済み PR(30日)
1

説明

The search feature has poor performance. Some important APIs (for example, clientOnly and ParentProps) that should appear in the search results are missing.

Also, there have been requests for the ability to search within normal text and code blocks. This functionality would be helpful for users looking to find examples of specific API usage.

Certain API options, such as deferStream, are also not searchable. This can be addressed by using headings to document API options instead of tables. This is being implemented gradually.

Related issues: (for more context and discussions)

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

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

調査の方向性

検索機能から始め、関連する Issue 987、109、1364、706 を確認して、背景とこれまでの議論を把握します。どの欠落している API、テキストおよびコードブロック、API オプションが対象範囲に含まれるかを判断し、その後、既存の結果を退行させることなく、影響を受けるコンテンツを検索できることを検証します。

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

評価

領域
documentation, search
issue の種類
バグ
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

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

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