reactjs / reactjs/react.dev

Inconsistency in react docs

Aberta
#1,096 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
JavaScript
Estrelas
11.8k
Forks
7.9k
Merge médio
1d 11h
PRs com merge (30d)
11

Descrição

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.

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece pela página vinculada React Top-Level API e compare as orientações de importação dela com as outras seções de API Reference mostradas na issue. Confirme a convenção da documentação e, em seguida, atualize as orientações restantes em texto simples, se apropriado; o trabalho estará concluído quando as seções de importação usarem uma redação e uma formatação consistentes.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
javascript, react
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.