[Suggestion]: Reference: component prop list shoud be more readable
まだ誰も着手していません。
- 主要言語
- JavaScript
- スター
- 11.8k
- フォーク
- 7.9k
- 平均マージ
- 1日 11時間
- マージ済み PR(30日)
- 11
説明
Summary
In my view, the current presentation of component props is somewhat unreadable and could benefit from refinement. This issue is particularly visible in long lists like this one: input props.
My propose is to improve indentations and alignment and to enhance visual clarity using existing tools:
- for the long lists, to use table
- for the short lists, to move description sentence into an inner nested list item and remove its bullet
- to remove articles (a/an) before types
P.S. I know, this is a bit influenced by the MDN Web Docs, but those are not poor UX decisions. Nonetheless, I welcome an active discussion on these suggestions.
Page
No response
Details
What it looks like now:
What it looks like with my suggestions applied:
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
リンクされた React input props のリファレンスページから始め、現在の表示を提供されたスクリーンショットと比較します。ほかのコンポーネントの prop リストを確認して、長いリストと短いリストのケースを特定し、そのうえで提案されているテーブル、入れ子になった説明、配置、記事の削除を検討します。影響を受けるリファレンスページのフォーマットが一貫してより明確になったら、作業は完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript, react
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 静か
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 45/100