DevDocs React documentation is missing code blocks from source documentation
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 42/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- react
調査の方向性
まず、リンクされたReactのソースページと対応するDevDocsのページを比較し、複数のファイルまたはコードブロックを含む例に注目します。次に、Reactのドキュメントのインポートおよびレンダリングの経路を追跡し、不足しているブロックとファイルのバリエーションが対応するDevDocsのページに表示されることを確認します。
索引モデルが issue の本文から書いたものです。
説明
Documentation style bug
- Search for existing issues
https://github.com/freeCodeCamp/devdocs/labels/docs%2Fimprovement - did not find similar via queries like "React", "code block", "codeblock"
Summary
The original React documentation usually presents a number of code blocks to demonstrate per concept or example. Often, one code block consists of multiple files which users can switch between, while devdocs only uses one of them. This article can be used for comparison: source != devdocs
Actual style
Expected style
- 主要言語
- Ruby
- スター
- 39.5k
- フォーク
- 2.6k
- 平均マージ
- 2日 9時間
- マージ済み PR(30日)
- 13
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
freeCodeCamp/devdocs のほかの issue
-
docs/improvement
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
freeCodeCamp/devdocs#1989 · コメント 4 件 · リアクション 4 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
freeCodeCamp/devdocs#2731 ·
-
feature
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
freeCodeCamp/devdocs#2712 ·
-
feature
難易度 5/5 1週間以上 初心者へのやさしさ 30/100
freeCodeCamp/devdocs#2683 · コメント 1 件 ·
-
feature
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
freeCodeCamp/devdocs#2673 ·
freeCodeCamp/devdocs の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
googleapis/google-api-ruby-client#28001 · リアクション 5 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100