reactjs / reactjs/react.dev

Documentation feedback

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

还没有人认领这个 Issue。

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

描述

As with lots of repos and libs, I often find myself thinking about improvements to and gaps within docs as I'm stepping through. Sure, there's ways of capturing it; submitting an issue, Gitter, some doc platforms allow contribution links from within the docs themselves.

If possible, I think it would be a great feature to include (post-Github login) just-in-time commentary on docs that fits into a lightweight review/contrib workflow - I'm thinking it would look/function similarly to Medium.com's annotation feature.

Perhaps it's feature-worthy instead of "just file an issue" etc, because performing available contribution steps is certainly possible but it removes learners from their learning experience and train of thought (also busy experienced devs). Why not let learners stay on track while also making annotations that, if reviewed after learning (or when finding a mistake) can then also be shared/submitted into a usable workflow for maintainers?

This would also allow contributions in the form of documentation review that doesn't require living and breathing in the contrib ecosystem (just want to get learning, I'll contrib when I'm ready, but my feedback could still be valuable to others).

贡献指南

打开贡献指南

从这里开始

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

调研方向

该 issue 没有指定文件、测试或入口点。先检查现有的 react.dev 贡献工作流,以及所请求的 GitHub 登录后注释体验。在实现之前,确定注释和维护者审查的范围;当学习者可以不离开学习流程就提交有用的文档反馈时,这项工作就完成了。

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

评估

技术栈
javascript, react
领域
documentation, frontend
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
20/100

把新 issue 发到你的邮箱

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