parse-community / parse-community/docs
📙 Consolidate Parse client SDK docs
Nobody has claimed this yet.
- Dominant language
- SCSS
- Stars
- 317
- Forks
- 507
- PR merge metrics
- No merged PRs in 30d
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.
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.
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.
Assessment
- Tech stack
- android, ios, macos
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100