Improve default styling and top-level content layout
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 20/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- css, fsharp, html
- 領域
- design, documentation, web-dev
調査の方向性
まず、現在のデフォルトの _template.html と FSharp.Formatting で使用されているスタイルを確認し、続いて、挙げられているレイアウト、オーバーフロー、間隔、関数名、ロゴリンクに関する懸念を比較します。issue で求められている議論と視覚的な例を使用して、具体的な受け入れ基準を定義します。完了とは、合意したデザインとコンテンツの変更が実装され、生成されたドキュメントのレイアウトがデスクトップとモバイルの表示で確認済みであることを意味します。
索引モデルが issue の本文から書いたものです。
説明
As noted by @baronfel in #27, the default styling and top-level layout needs improvement.
What is here is the current default styling for FSharp.Formatting using the standard _template.html, which is tight for iteration but we can do better. If necessary we can add a _template.html or fsdocs-styles.css in here though to be honest I'd love it if we could make the default FSharp.Formatting _template.html good enough to be both configurable for the needs of this repo and to satisfy and please.
Please make a note below everything that you do/don't like about the current design, layout and content. If possible give specific (preferably visual) examples of what you want improved, and, if possible, give links to how those improvements might be made in terms of CSS improvements and JS framework changes.
The things I've noticed so far:
-
The scrollbar on the left appears even if its not needed. This is I believe because of horizontal overflow.
-
Agreed with @baronfel the basic look is very sparse (though I quite enjoyed browsing it on my phone earlier). Also this is tricky as the site is not like most other doc sites as it is only doing FSHarp.Core API docs and is not a general tech doc site.
-
The repetition of parameter XML doc with parameter types is a bit painful (this is an F#F issue)
-
There is a glitch iwhere function names and parameters run together for active patterns and some module functions
-
Agreed with @cartermp that the link on the logo should go to https://fsharp.org
- 主要言語
- 言語のデータがありません
- スター
- 37
- フォーク
- 20
- 平均マージ
- 5分
- マージ済み PR（30日）
- 2
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
fsharp/fsharp-core-docs のほかの issue
-
Missing namespaces? オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
fsharp/fsharp-core-docs#104 · コメント 6 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
fsharp/fsharp-core-docs#103 · コメント 4 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 38/100
fsharp/fsharp-core-docs#82 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
fsharp/fsharp-core-docs#76 · コメント 4 件 · リアクション 9 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
fsharp/fsharp-core-docs#75 · コメント 3 件 · リアクション 1 件 ·
fsharp/fsharp-core-docs の issue をすべて見る
似ている issue
-
area/busola/ux
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
kyma-project/busola#5344 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
deck: add to staging enhancement feature: UI Cleanup & Documentation level: easy priority: MUST HAVE ready for dev lead role: DevOps size: 1pt
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
hackforla/tdm-calculator#3547 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
SAP/fundamental-ngx#14560 ·