Indicate whether a link is external
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
Related: #1605
React docs have lots of links to external articles, videos or even Stack Overflow questions. For example, the "Hello World" page has this:
Note This guide occasionally uses some of the newer JavaScript syntax in the examples. If you haven’t worked with JavaScript in the last few years, these three points should get you most of the way.
While this link is helpful to English speakers, it can easily disappoint readers of translated versions because many of them do not understand English well.
This can be especially unfriendly when they cannot reasonably guess whether the linked material is in English or not from its text or the context ("these points", "here", "said", "ES6 class", "weird bug" etc). Unfortunately, the current docs are full of instances like this.
In the long run, we can reduce the number of such confusing links, for example:
Note This guide occasionally uses some of the newer JavaScript syntax in the examples. If you haven’t worked with JavaScript in the last few years, the following article should get you most of the way.
But for the time being, I suggest indicating external links using an icon (e.g., 🌎) or a different color. It can signal the linked article is likely to be written in English. Maybe links to an MDN article can have a different icon because it usually has a translated version.
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece revisando como os links são renderizados em todo o site de documentação do React e leia a issue relacionada #1605 para entender o contexto. Faça um inventário dos links externos, incluindo links para MDN, e considere o trabalho concluído quando os leitores puderem distinguir material externo de links internos sem depender do texto do link.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- javascript, react
- Domínio
- accessibility, design, documentation
- Tipo de issue
- Funcionalidade
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100