SDWebImage/SDWebImageSwiftUI

Help wanted - Polish our document site

Open

#52 ouverte le 12 nov. 2019

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)Swift (256 forks)github user discovery
help wanted

Métriques du dépôt

Stars
 (2 546 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

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 ?

Guide contributeur

Direction de recherche
Recherchez des sites de documentation modernes avec gestion de version (par exemple, Docusaurus, VuePress ou personnalisé). Explorez les thèmes et la réactivité mobile. Comprenez comment Jazzy génère les documents et comment l'intégrer ou le remplacer.
Stack technique
htmlcssjavascript
Domaine
frontenddocumentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Plus d'une semaine
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.
Plutôt claire
Prérequis
front end developmentHTMLCSSJavaScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40