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

Convert Playgrounds to DocC Interactive Tutorials #4

Open
2 of 21 tasks
cbaker6 opened this issue Oct 22, 2022 · 0 comments
Open
2 of 21 tasks

Convert Playgrounds to DocC Interactive Tutorials #4

cbaker6 opened this issue Oct 22, 2022 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@cbaker6
Copy link
Member

cbaker6 commented Oct 22, 2022

New Feature / Enhancement Checklist

Current Limitation

The SDK supports DocC Interactive Tutorials, but currently has no interactive tutorials. These tutorials can be used to teach developers how to use the SDK.

All of the current tutorials are in Swift Playgrounds.

Feature / Enhancement Description

Use the Swift Playgrounds as a baseline to make Interactive tutorials. These tutorials should include images/screenshots. This is useful when:

  1. A developer wants view our tutorials online at https://netreconlab.github.io/Parse-Swift/release/tutorials/parseswift/
  2. A developer depends on the Parse-Swift SDK using SPM and goes to "Xcode->Product->Build Documentation" in their project locally

image

The initial tutorial file that should be edited is here: https://github.com/netreconlab/Parse-Swift/blob/main/Sources/ParseSwift/Documentation.docc/Your%20First%20Object.tutorial

The Swift Playgrounds should be left intact as they give developers a real way to test the SDK against a Parse Server. Feel free to tackle individual tutorials in separate PR's. You can leverage text from the original Objective-C SDK guide. Much of the Swift Playground code uses completion handlers for asynchronous code. It will be beneficial to write most of the code in the tutorial using try await instead.

Tutorials with a checkbox have already been converted from their Swift Playgrounds counterparts:

  • 1 - Your first Object
  • 2 - Finding Objects
  • 3 - User - Sign Up
  • 4 - User - Continued
  • 5 - ACL
  • 6 - Installation
  • 7 - GeoPoint
  • 8 - Pointers
  • 9 - Files
  • 10 - Cloud Code
  • 11 - LiveQuery
  • 12 - Roles and Relations
  • 13 - Operations
  • 14 - Config
  • 15 - Custom ObjectId
  • 16 - Analytics
  • 17 - SwiftUI - Finding Objects
  • 18 - SwiftUI - Finding Objects With Custom ViewModel
  • 19 - SwiftUI - LiveQuery

Example Use Case

Completed tutorials will look like: https://developer.apple.com/tutorials/swiftui

Videos for Designing DocC Tutorials

Alternatives / Workarounds

Solely depend on Playground implementations for demonstrating how to use SDK.

3rd Party References

https://developer.apple.com/tutorials/swiftui

@cbaker6 cbaker6 added the enhancement New feature or request label Nov 4, 2022
@cbaker6 cbaker6 pinned this issue Dec 2, 2022
@cbaker6 cbaker6 added the good first issue Good for newcomers label Jan 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant