SDWebImage/SDWebImageSwiftUI

Help wanted - Polish our document site

Open

#52 aperta il 12 nov 2019

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Swift (256 fork)github user discovery
help wanted

Metriche repository

Star
 (2546 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

SDWebImage have a official site for holder documentation: https://sdwebimage.github.io/

However, there are some limits:

  • It only hold SDWebImage this core framework, but not any other components around, like SDWebImageSwiftUI Supported via different directory path in URL
  • It only support one version, can not show previous version and the update will override previous
  • It use jazzy to generate documentation, but the theme does not looks so great. Not optimized for mobile Safari browser and some content are clipped because of length too long.

Can anyone with the front-end knowledge, can help us to build a better documentation site, like Realm docuemntation. To overcome all 3 disadvantages thing I talked above ?

Guida contributor

Direzione di ricerca
Esplora siti di documentazione moderni con versionamento (es. Docusaurus, VuePress o personalizzati). Esamina temi e reattività mobile. Comprendi come Jazzy genera i documenti e come integrarlo o sostituirlo.
Tech stack
htmlcssjavascript
Dominio
frontenddocumentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Oltre 1 settimana
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
front end developmentHTMLCSSJavaScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40