bytecodealliance / bytecodealliance/component-docs
Add more diagrams to the component docs
- Vorherrschende Sprache
- Rust
- Sterne
- 137
- Forks
- 88
- Ø Merge
- 5 T. 12 Std.
- Gemergte PRs (30 T.)
- 4
Beschreibung
Can make the book more consumable
More graphics/images: Images and graphics drive our point home and help with retention. We should consider reinforcing concepts graphically with ALT text + captions. We must consider the graphic/imaging software we intend to use with our current SSG since not all frameworks integrate well with every SSG.
There is a way to make diagrams work in both light and dark mode -- we should use this magical technique if we can
ref https://github.com/bytecodealliance/component-docs/issues/101#issue-2172995182
Beitragsleitfaden
Rechercherichtung
Beginne mit der Durchsicht der aktuellen Komponentendokumentation und des referenzierten Issues zu Diagrammen. Ermittle, wie der aktuelle SSG Diagramme in hellen und dunklen Modi unterstützen kann, einschließlich ALT-Text und Bildunterschriften, und bestimme, welche Grafiksoftware kompatibel ist. Als erledigt gilt die Aufgabe, wenn die Komponentendokumentation nützliche Diagramme mit barrierefreiem Text und Bildunterschriften enthält, die in beiden Themes funktionieren.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- wasm
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 30/100