[Proposal] Improve TypeScript tsconfig reference web page usability
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- javascript, typescript
調査の方向性
まず、TypeScript の元の tsconfig リファレンスページを、リンクされているモックの tsconfig リファレンスページおよびその提案概要と比較します。ページに提案された 2 列レイアウト、検索、フィルタリングされた構成セクション、ツールチップがあり、実装が TypeScript-Website に統合されていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Summary
When visiting the original TypeScript tsconfig reference documentation web page, the first impression right away is that the page is Brobdingnagian, overweight and overwhelming. It has all the vast amount of configuration information crammed into a single, huge page that's hard to scroll and hard to survey.
From my personal point of view, it's too hard to find pertinent information therein in a timely manner. This is particularly true for daily work, where configuring TSC is not supposed to become a full-time task.
I propose to add search and filter options to the page as well as a new page layout, supposed to resemble the powerful, simple and easy to grasp File Explorer design.
Proposal
Using the original tsconfig reference documentation web page, I created a simple mock tsconfig reference page, visualizing my proposal:

Proposal Overview
The changes are simple and easy to implement:
-
Re-arranging configuration property hyperlinks and content into two flex columns, restricting their max height to match the browser window height
-
Adding a search bar to the top of the left flex block, along with the corresponding JavaScript
-
When activating any of the configuration property hyperlinks, show filtered content in the right flex block by hiding all sections not addressed by the hyperlink
-
Add an informative tooltip to each of the configuration property hyperlinks
You find the corresponding GitHub repository containing my mock implementation here:
- 主要言語
- TypeScript
- スター
- 2.6k
- フォーク
- 1.5k
- 平均マージ
- 2日 12時間
- マージ済み PR(30日)
- 8
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
microsoft/TypeScript-Website のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
microsoft/TypeScript-Website#3611 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
microsoft/TypeScript-Website#3607 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 65/100
microsoft/TypeScript-Website#3039 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
microsoft/TypeScript-Website#2998 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
microsoft/TypeScript-Website#3614 ·
microsoft/TypeScript-Website の issue をすべて見る
似ている issue
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
Crush オープン
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md オープン
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
ElementsProject/cln-application#167 · コメント 1 件 · リアクション 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
Quantco/pnpm-licenses#17 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100