ChartsOrg/Charts

Create documentation

Open

#4,386 opened on Jun 4, 2020

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

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

Tech stack
swiftios
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
SwiftiOS developmentCharts library knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Focus on the 'combined charts' feature and readonly properties that are documented in the Android version. Review existing source code to understand the current API and identify undocumented public interfaces. Look at any open pull requests or issues that may have discussed documentation structure. Consider creating a documentation skeleton first and then filling in sections for combined charts and readonly properties. The official Charts repository on GitHub (ChartsOrg/Charts) has no documentation directory yet, so you'll need to propose a structure (e.g., using Jazzy or Markdown).