ChartsOrg/Charts

Create documentation

Open

#4,386 opened on Jun 4, 2020

View on GitHub
 (1 comment) (2 reactions) (0 assignees)Swift (6,009 forks)batch import
help wanted

Repository metrics

Stars
 (28,002 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

This project has evolved enough to deserve its own documentation. There is no documentation to do many things that are advertised like combined charts etc. Also, there are readonly properties that are not in the Android project this library was inspired on. This project needs documentation.

Contributor guide

Research direction
Identify missing documentation areas like combined charts and read only properties, then create documentation files comparing with the Android project.
Tech stack
swift
Domain
mobile
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90