📙 Consolidate Parse client SDK docs

parse-community / docs

Parse Platform docs

https://docs.parseplatform.org

Other

313 stars 518 forks source link

📙 Consolidate Parse client SDK docs #756

Open mtrezza opened 4 years ago

mtrezza commented 4 years ago

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.

TomWFox commented 4 years ago

Could work. We did discuss this a bit on the old forum - although with more of a focus on a Stripe style api doc. I think there are some things to consider like...

How to display platform specific info.
Features that are implemented in some SDKs or implemented differently - for example with different handling of edge cases.
How to handle sections of the docs which are very platform specific e.g. push notifications, maybe setup, maybe local storage.

mtrezza commented 3 years ago

To pick this up, If anyone can suggest a more modern docs framework, please comment.

Requirements I'd say are:

Open source
Well maintained with frequent commits and sizable collaborator pool
Modern layout
Adaptive layout (mobile+touch vs. desktop+click)
Standardized layout features such as info, warning, etc
Ability to switch coding language on the fly to incorporate all SDKs and APIs in one doc
Day / night mode, may seem unimportant, unless you spend a lot of time reading it as new developer
nice to have: Try it out feature to send requests to a demo parse server

For example:

https://docusaurus.io