Swift DSL for DocC Interactive Tutorial

[ApolloZhu]

Overview

DocC documentation is a new tool released by Apple during WWDC21 that helps developers create Apple-style documentation for their code, as well as interactive tutorials that shows step-by-step instructions on how to get started in using those code.

This project aims to provide an alternative way to author DocC interactive tutorials leveraging error checking capability of the Swift compiler through a new domain-specific language (DSL).

How you can contribute

• Investigate the exact implementation and restrictions of DocC interactive tutorial markdown
• Write code that implements the DSL
• Write DocC interactive tutorial in markdown
  • (Later) write DocC interactive tutorial in the new DSL
• Manage project contributors, balance the workload, and check in on progress

Expectations

• Everyone:
  • Watch https://developer.apple.com/videos/play/wwdc2021/10235 to understand what DocC interactive tutorial is, and how to author one using markdown files
  • Attend most of the regular meetings
• If you'd like to contribute code:
  • Have a basic understanding of Swift by reading https://docs.swift.org/swift-book/GuidedTour/GuidedTour.html (for those with some programming background), or talk to @ApolloZhu about how to get started
  • Watch https://developer.apple.com/videos/play/wwdc2021/10253 to learn how to implement a DSL in Swift
  • Implement parts of the code as promised

Join the Project

• Contact: @ApolloZhu (Apollonian#0033 on Discord)
• Meeting location: online (but can meet on Seattle campus if desired)
• Meeting times: to be decided (depending on members' schedule and avaiability)
• GitHub: https://github.com/UWDevApp/DocCUtils (private for now)