warriordog/mooltipage

Docs: Semantic HTML fixes

Aberta

#49 aberto em 4 de out. de 2020

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)TypeScript (4 forks)auto 404
documentationenhancementgood first issue

Métricas do repositório

Stars
 (1 estrela)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Some parts of the documentation don't make proper use of semantic HTML. These issues should be fixed:

  • Use page-section tag in index.html
  • Split p tags into actual paragraphs in all parts of getting started section
  • Move inline example code into figure tags (!! this might need CSS tweaks)

Guia do colaborador

Direção de pesquisa
Revise os arquivos de documentação quanto ao uso de HTML não semântico. Substitua divs genéricos por tags semânticas como <section>, <figure> e divida longos blocos <p> em vários parágrafos. Para a alteração da tag figure, verifique se o CSS ou JavaScript existente tem como alvo esses elementos e ajuste conforme necessário.
Pilha de tecnologia
typescript
Domain
frontenddocumentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
HTML
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85