reactjs / reactjs/react.dev

More granular linking in docs

未关闭
#6,038 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

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

描述

This is a feature request.
I think it would be very useful to be able to link to specific paragraphs or callouts, etc.
For example, in the image below, I can't link the actual pitfall, rather, I can only link the the top level header that contains it, several paragraphs up.

Making more things linkable will make the docs much more interactive, in my opinion. I would be able to point people to specific bits of information.

image

I don't think that there is one simple rule that can be applied for this obviously, because many paragraphs can't be taken in without more context. But maybe some heuristics can be applied to cover a large percentage of the content.

Is this the right place for this feature request? Will you accept PRs for this? Is there some accessiblity concern I'm unaware of?

贡献指南

打开贡献指南

从这里开始

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

调研方向

该 issue 未指定任何文件、测试或入口点。首先定位文档站点当前的标题链接行为,并检查段落和 callout 是如何渲染的。完成标准是定义并实现一种一致且易访问的方式来链接到特定内容,并覆盖具有代表性的文档示例。

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

评估

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

把新 issue 发到你的邮箱

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