reactjs / reactjs/react.dev

Move Suspense introduction to the main docs repo

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

还没有人认领这个 Issue。

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

描述

I asked for this before, but the official docs should not lightly link to external articles to explain basic React concepts, because external articles cannot be translated.

Currently, this external RFC, available only in English, is somehow treated as the "official get-started guide" for Suspense, useTransition, etc. It is linked from many pages in the main docs, including recent blog articles. On the other hand, information in the current docs is limited, and they do not explain a Suspense forms a "catch block (boundary)", for example. It's hard for non-English speakers to understand how to use the new concurrent features now.

The React team even deleted the old Concurrent Mode docs without providing alternative articles, which means the most comprehensible introduction for Suspense is now lost at least in my language. I understand they were outdated, but they were better than nothing. The removed files are redirected to 17.reactjs.org, but 17. is not available in other languages.

Please consider the following:

  1. Copy the contents of the RFC to somewhere in the main docs so that translators can work on them.
  2. Meanwhile, restore the Concurrent Mode docs and revert the redirects so that non-English speakers can read them again. It's fine to warn they are severely outdated, but there is no reason to make them completely unavailable in other languages.

贡献指南

打开贡献指南

从这里开始

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

调研方向

首先阅读链接的 Suspense RFC,以及 issue 中引用的已移除 Concurrent Mode 文档,然后检查主文档如何链接到它们,以及重定向在哪里配置。确定是否可以将 RFC 改编为主仓库中可翻译的文档,以及恢复旧页面是否仍然合适;当约定的介绍和重定向行为可供翻译人员使用时,即视为完成。

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

评估

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

把新 issue 发到你的邮箱

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