reactjs / reactjs/react.dev

Documentation feedback

Aberta
#476 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

As with lots of repos and libs, I often find myself thinking about improvements to and gaps within docs as I'm stepping through. Sure, there's ways of capturing it; submitting an issue, Gitter, some doc platforms allow contribution links from within the docs themselves.

If possible, I think it would be a great feature to include (post-Github login) just-in-time commentary on docs that fits into a lightweight review/contrib workflow - I'm thinking it would look/function similarly to Medium.com's annotation feature.

Perhaps it's feature-worthy instead of "just file an issue" etc, because performing available contribution steps is certainly possible but it removes learners from their learning experience and train of thought (also busy experienced devs). Why not let learners stay on track while also making annotations that, if reviewed after learning (or when finding a mistake) can then also be shared/submitted into a usable workflow for maintainers?

This would also allow contributions in the form of documentation review that doesn't require living and breathing in the contrib ecosystem (just want to get learning, I'll contrib when I'm ready, but my feedback could still be valuable to others).

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

A issue não nomeia arquivos, testes ou pontos de entrada. Comece revisando o workflow de contribuição existente do react.dev e a experiência de anotações solicitada após o login no GitHub. Defina o escopo das anotações e da revisão pelos mantenedores antes da implementação; o trabalho estará concluído quando os alunos puderem enviar feedback útil sobre a documentação sem sair do fluxo de aprendizado.

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

Avaliação

Stack de tecnologia
javascript, react
Domínio
documentation, frontend
Tipo de issue
Funcionalidade
Dificuldade
5/5
Tempo estimado
Mais de uma semana
Status de atividade
Estagnada
Clareza
Precisa de esclarecimento
Facilidade para iniciantes
20/100

Receba novas issues na sua caixa de entrada

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