reactjs / reactjs/react.dev

More granular linking in docs

Open
#6,038 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
11.8k
Forks
7.9k
Avg merge
1d 11h
Merged PRs (30d)
11

Description

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?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by locating the documentation site's current heading-link behavior and reviewing how paragraphs and callouts are rendered. Done means defining and implementing a consistent, accessible approach for linking specific content, with coverage for representative documentation examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.