reactjs / reactjs/react.dev

Suggestion: Link each mention of a React API to the reference docs

Offen
#2,630 1 Kommentar 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

I'm new to React and just started reading the documentation.

I noticed that references to the API are not links, just plain text. It would be helpful if they were actual links to the API.

Example: On this page https://reactjs.org/docs/rendering-elements.html it says:

image

The yellow API reference should actually be a link to the ReactDOM.render(), meaning a link to https://reactjs.org/docs/react-dom.html#render.
This helps me a lot because I can easily discover the complete reference of that function, the complete list and description of the parameters, function behaviors, different possible usage, etc.
As I go through the documentation and concepts, I can quickly go back and forth between concepts and API reference. It's much quicker to have links I can open in a new tab, instead of manually searching in the API reference every time.

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

Beginne mit der im Issue genannten Dokumentationsseite zu Rendering-Elementen und suche dort nach der im Klartext enthaltenen Referenz auf ReactDOM.render(). Überprüfe die umgebende Dokumentation auf weitere API-Erwähnungen, die auf dieselbe Weise behandelt werden müssen; abgeschlossen ist die Aufgabe, wenn diese Referenzen auf die entsprechenden API-Referenzseiten verlinken.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, react
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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