warriordog/mooltipage

Docs: Semantic HTML fixes

Offen

#49 geöffnet am 04.10.2020

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (4 Forks)auto 404
documentationenhancementgood first issue

Repository-Metriken

Stars
 (1 Stern)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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)

Contributor Guide

Research-Richtung
Überprüfen Sie die Dokumentationsdateien auf nicht semantische HTML Nutzung. Ersetzen Sie generische Divs durch semantische Tags wie <section>, <figure> und teilen Sie lange <p> Blöcke in mehrere Absätze auf. Für die Änderung des figure Tags prüfen Sie, ob vorhandenes CSS oder JavaScript auf diese Elemente abzielt und passen Sie es entsprechend an.
Tech Stack
typescript
Domain
frontenddocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
HTML
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85