Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📙 Consolidate Parse client SDK docs #756

Open
mtrezza opened this issue Aug 6, 2020 · 2 comments
Open

📙 Consolidate Parse client SDK docs #756

mtrezza opened this issue Aug 6, 2020 · 2 comments

Comments

@mtrezza
Copy link
Member

mtrezza commented Aug 6, 2020

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.

@mtrezza mtrezza changed the title 📙 Consolidate Parse docs 📙 Consolidate Parse client SDK docs Aug 6, 2020
@TomWFox
Copy link
Contributor

TomWFox commented Aug 6, 2020

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
Copy link
Member Author

mtrezza commented Feb 11, 2021

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants