reactjs / reactjs/react.dev

More granular linking in docs

Offen
#6,038 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
JavaScript
Sterne
11.8k
Forks
7.9k
Ø Merge
1 T. 11 Std.
Gemergte PRs (30 T.)
11

Beschreibung

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?

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Das Issue nennt keine Dateien, Tests oder Einstiegspunkte. Beginne damit, das aktuelle Verhalten von Überschriften-Links der Dokumentationswebsite zu ermitteln und zu prüfen, wie Absätze und Callouts gerendert werden. Als abgeschlossen gilt die Definition und Implementierung eines konsistenten, barrierefreien Ansatzes zum Verlinken bestimmter Inhalte mit Abdeckung für repräsentative Dokumentationsbeispiele.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, react
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.