SDWebImage/SDWebImageSwiftUI

Help wanted - Polish our document site

Open

#52 opened on Nov 12, 2019

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Swift (256 forks)github user discovery
help wanted

Repository metrics

Stars
 (2,546 stars)
PR merge metrics
 (PR metrics pending)

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 ?

Contributor guide

Research direction
Research modern documentation sites with versioning (e.g., Docusaurus, VuePress, or custom). Explore theming and mobile responsiveness. Understand how Jazzy generates docs and how to integrate or replace it.
Tech stack
htmlcssjavascript
Domain
frontenddocumentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
front end developmentHTMLCSSJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40