nodejs / nodejs/node

Render "About this documentation" as the landing page for the documentation section

Offen
#60,667 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
JavaScript
Sterne
122k
Forks
37.3k
Ø Merge
4 T. 2 Std.
Gemergte PRs (30 T.)
283

Beschreibung

URL:

https://nodejs.org/docs/latest/api/

Browser Name:

Safari

Browser Version:

26.0.1 (21622.1.22.11.15)

Operating System:

MacOS 26.0.1

How to reproduce the issue:

Upon opening the documentation page, the user sees two table of contents, one in the navigation bar and one as the landing page as shown here:

Image

I think it would be more visually consistent if the landing page were “About this documentation.” Such as this snapshot below:

Image

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

Öffne zunächst https://nodejs.org/docs/latest/api/ und vergleiche die aktuelle Einstiegsseite mit der vorgeschlagenen Ansicht „About this documentation“, die im Issue gezeigt wird. Verfolge anschließend den Dokumentationseinstiegspunkt, der diese Seite generiert, und bestätige dann, dass die Navigation und die Einstiegsseite keine redundanten Inhaltsverzeichnisse mehr enthalten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

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

Neue Issues direkt in Ihr Postfach

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