warriordog/mooltipage

Docs: Semantic HTML fixes

Aperta

#49 aperta il 4 ott 2020

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)TypeScript (4 fork)auto 404
documentationenhancementgood first issue

Metriche repository

Star
 (1 stella)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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)

Guida contributor

Direzione di ricerca
Esaminare i file di documentazione per l'uso di HTML non semantico. Sostituire i div generici con tag semantici come <section>, <figure> e dividere i lunghi blocchi <p> in più paragrafi. Per la modifica del tag figure, verificare se CSS o JavaScript esistenti hanno come target quegli elementi e regolarli di conseguenza.
Tech stack
typescript
Dominio
frontenddocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
HTML
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85