ChartsOrg/Charts

Create documentation

Open

#4,386 建立於 2020年6月4日

在 GitHub 查看
 (1 留言) (2 反應) (0 負責人)Swift (28,002 star) (6,009 fork)batch import
help wanted

描述

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.

貢獻者指南

技術棧
swiftios
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
4
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
over 1 week
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
SwiftiOS developmentCharts library knowledge
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
25
研究方向
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).