reactjs / reactjs/react.dev

Inconsistency in react docs

未关闭
#1,096 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
JavaScript
星标
11.8k
派生
7.9k
平均合并
1 天 11 小时
30 天内合并 PR
11

描述

I wanted to open an issue some days ago about some inconsistencies I found in the documentation of react, today I saw again and saw most of them were fixed as the image below. In API REFERENCE import sections is now as:

doc_img

in other sections it was in plain text. The only section which still has plain text is React Top-Level API, I am not sure if it should be modified at least from "If you use ES6 with npm, you can write import React from..." as the other sections has.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从链接的 React Top-Level API 页面开始,将其中的导入说明与 issue 中显示的其他 API Reference 部分进行比较。确认文档约定,然后在适当的情况下更新其余纯文本说明;完成的标准是导入部分使用一致的措辞和格式。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript, react
领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。