Add documenation
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- swift
- Domain
- documentation
Research direction
Review the Swift source to identify the methods that lack documentation, then check how Jazzy is configured or invoked for this repository. Done means each method is documented and Jazzy successfully generates the project documentation.
Written by the indexing model from the issue text.
Description
Document each method and generate documentation with Jazzy
- Dominant language
- Swift
- Stars
- 227
- Forks
- 45
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from mapbox/mapbox-arkit-ios
-
Difficulty 5/5 Over a week Newbie friendliness 10/100
mapbox/mapbox-arkit-ios#46 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 20/100
mapbox/mapbox-arkit-ios#45 · 2 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
mapbox/mapbox-arkit-ios#43 ·
-
Difficulty 5/5 Over a week Newbie friendliness 15/100
mapbox/mapbox-arkit-ios#42 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 15/100
mapbox/mapbox-arkit-ios#41 ·
All issues in mapbox/mapbox-arkit-ios
Similar issues
-
copy design-review mac P3
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
tosunlab/hisarapp-core#510 ·
-
bug needs-triage S2: major
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
manaflow-ai/cmux#26321 · 1 comment ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
SwiftyLab/MetaCodable#169 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
521xueweihan/HelloGitHub#4131 ·