High-level reorganization
未关闭
还没有人认领这个 Issue。
discussion
type: documentation
type: infra
- 主要语言
- JavaScript
- 星标
- 11.8k
- 派生
- 7.9k
- 平均合并
- 1 天 11 小时
- 30 天内合并 PR
- 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
stateand other APIs are introduced without broader context. - Make API reference more prominent, at the same level as the Guide and Tutorial (PR #178)
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先检查当前主页、Getting Started、Tutorial 和 API 参考文档的入口点,然后将列出的提案与现有的信息架构进行比较。完成这项工作需要一份已达成共识且可执行的重组计划;此 issue 未指定文件、测试或要实现的具体变更。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- javascript, react
- 领域
- content, documentation
- Issue 类型
- 文档
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 25/100