warriordog/mooltipage

Docs: Semantic HTML fixes

Ouverte

#49 ouverte le 4 oct. 2020

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)TypeScript (4 forks)auto 404
documentationenhancementgood first issue

Métriques du dépôt

Stars
 (1 étoile)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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)

Guide contributeur

Direction de recherche
Examinez les fichiers de documentation pour l'utilisation de HTML non sémantique. Remplacez les divs génériques par des balises sémantiques comme <section>, <figure> et divisez les longs blocs <p> en plusieurs paragraphes. Pour la modification de la balise figure, vérifiez si le CSS ou JavaScript existant cible ces éléments et ajustez en conséquence.
Stack technique
typescript
Domaine
frontenddocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
HTML
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85