📙 Consolidate Parse client SDK docs
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- android, ios, macos
- Domain
- documentation
Research direction
Start by reviewing the existing Parse client SDK documentation and the iOS SDK docs' Swift/ObjC tab or switch pattern. Map duplicated content across the iOS, macOS, Android, and REST sections, then consolidate it into one tabbed client SDK document without losing platform-specific examples.
Written by the indexing model from the issue text.
Description
Issue
The Parse docs are structured in a way that results in duplicate information as every client SDK documentation has mostly the same content.
- This makes it difficult to maintain and increases the workload for changes as they have to be made across every SDK docs.
- It increases the risk for error / inconsistencies across SDK docs.
Suggested solution
Consolidate all client SDK docs in to a single client SDK doc. Use tabs / switches within the doc to change the SDK code examples (iOS, macOS, Android, REST, etc.), similar to how it is already done in the iOS SDK docs for Swift / ObjC.
- Dominant language
- SCSS
- Stars
- 317
- Forks
- 506
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
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 parse-community/docs
-
📙 Opendocs:cloud-code type:docs
Difficulty 1/5 1-3 hours Newbie friendliness 72/100
parse-community/docs#936 ·
-
type:bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
parse-community/docs#889 · 7 comments ·
-
docs:sdk-js
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
parse-community/docs#961 ·
-
type:bug
Difficulty 4/5 3-5 days Newbie friendliness 25/100
parse-community/docs#950 · 2 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
parse-community/docs#947 ·
All issues in parse-community/docs
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·