NativeScript / NativeScript/docs

Improve search results

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

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

主要言語
JavaScript
スター
17
フォーク
31
平均マージ
8時間 51分
マージ済み PR(30日)
2

説明

I think there are 2 things to improve in the results, one is the order and the other is the name of the section in which they appear.
For example, in the image I show I am searching for stackLayout and searches related to stackLayout appear before the component itself.

  1. Improvement in order: When performing the search I think the entry to the component should appear first
  2. Incoherent titles: When searching for stackLayout the entry that is related to the component appears in the Documentation section. It's all documentation, right? I think a more coherent title would be the documentation space itself: UI Components.
  3. Incorrect section: This is related to the previous point, 2 StackLayout entries appear within Documentation, one is the component and the other is the API. This is quite confusing, I think each entry should appear with the title of the documentation section, for the component UI Components and for the API API Reference.
image

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

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

はじめの一歩

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

調査の方向性

issue に示されている stackLayout 検索を再現し、検索のエントリポイントとドキュメントセクションのメタデータを調べてください。コンポーネントのエントリと API のエントリがどのような順序で並び、どのようにラベル付けされているかを確認してください。コンポーネントの結果が関連する結果より先に表示され、コンポーネントのエントリに UI Components、API のエントリに API Reference のラベルが付いていれば完了です。

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

評価

技術スタック
javascript
領域
documentation, search
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
38/100

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

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