bytecodealliance / bytecodealliance/component-docs

Add more diagrams to the component docs

Aperta
#253 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub
documentation enhancement
Lingua principale
Rust
Stelle
137
Fork
88
Merge medio
5g 12h
PR unite (30g)
4

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia esaminando la documentazione attuale del componente e l’issue di riferimento sui diagrammi. Individua come l’SSG attuale può supportare i diagrammi nelle modalità chiara e scura, inclusi il testo ALT e le didascalie, e determina quale software di grafica è compatibile. Il lavoro è completato quando la documentazione del componente contiene diagrammi utili con testo accessibile e didascalie che funzionano in entrambi i temi.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
wasm
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.