reactjs / reactjs/react.dev

Inconsistency in react docs

Ouverte
#1,096 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
JavaScript
Étoiles
11.8k
Forks
7.9k
Merge moyen
1 j 11 h
PR mergées (30 j)
11

Description

I wanted to open an issue some days ago about some inconsistencies I found in the documentation of react, today I saw again and saw most of them were fixed as the image below. In API REFERENCE import sections is now as:

doc_img

in other sections it was in plain text. The only section which still has plain text is React Top-Level API, I am not sure if it should be modified at least from "If you use ES6 with npm, you can write import React from..." as the other sections has.

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 la page React Top-Level API liée et comparez ses indications d’importation avec les autres sections API Reference présentées dans l’issue. Confirmez la convention de documentation, puis mettez à jour les indications restantes en texte brut si nécessaire ; le travail est terminé lorsque les sections d’importation utilisent une formulation et une mise en forme cohérentes.

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

Évaluation

Stack technique
javascript, react
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

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