reactjs / reactjs/react.dev

High-level reorganization

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

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

discussion type: documentation type: infra
主要言語
JavaScript
スター
11.8k
フォーク
7.9k
平均マージ
1日 11時間
マージ済み PR(30日)
11

説明

Per some discussions on Reactiflux (w/@markerikson), thought it might be a good idea to start tracking some high-level ideas for organizing the docs.

What's great about the current docs
  • Lots of examples
  • Concepts grouped by domain (forms, styling, etc.)
  • Runnable code
  • Real-world app tutorial
  • Good search feature through Algolia
What's not so good
  • Too many paths through the docs: On the 1st page you can either scroll down and go through the examples, Get Started and jump to Hello World (bypassing Install), or go the Tutorial
  • Not entirely clear what the distinction is between "Getting Started" and "Tutorial"
  • API docs feel hidden
Other projects with great docs

... and what can be learned from them...

  • Vue has been cited lately as having great docs that "can get you off the ground in 20 mins" (paraphrasing). In particular it's easy to read the docs top-to-bottom.
    • Docs are pretty linear; sections do not compete with other to describe concepts
    • Diagrams to explain tricky flows
  • Preact explains the whole API in a few pages; not sure if it it entirely what you need if you are a total beginner, but it's certainly digestable and links out to other content where needed.
Proposals

Move stuff here if it seems actionable

  • Make home page examples into the first page of Getting Started, and remove code from below-the-fold section on homepage
  • Add diagrams for component lifecycle/vdom sync. The community has already created lots of these for blog posts and talks; maybe one could be licensed for inclusion.
  • Add a page that describes the motivation for the VDOM (ie, creating UIs that respond deterministically to data), and where the top-level React APIs (createElement, Element, render) fit into that model. This would help correct a "forest for the trees" problem where state and other APIs are introduced without broader context.
  • Make API reference more prominent, at the same level as the Guide and Tutorial (PR #178)

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

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

はじめの一歩

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

調査の方向性

まず現在のホームページ、Getting Started、Tutorial、API リファレンスの各エントリーポイントを確認し、次に列挙されている提案を既存の情報アーキテクチャと比較してください。完了とするには、合意済みで実行可能な再編成計画が必要です。この issue では、ファイル、テスト、または実装すべき具体的な変更は指定されていません。

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

評価

技術スタック
javascript, react
領域
content, documentation
issue の種類
ドキュメント
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

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

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