nodejs / nodejs/node

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

Ouverte
#60,667 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
JavaScript
Étoiles
122k
Forks
37.3k
Merge moyen
4 j 2 h
PR mergées (30 j)
283

Description

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par ouvrir https://nodejs.org/docs/latest/api/ et comparez la page d’accueil actuelle avec la vue proposée « About this documentation » présentée dans l’issue. Suivez ensuite le point d’entrée de la documentation qui génère cette page, puis confirmez que la navigation et la page d’accueil ne présentent plus de tables des matières redondantes.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript
Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
55/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.