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

Interactive tutorial for building interactive tutorials #1005

Open
jverkoey opened this issue Aug 7, 2024 · 0 comments
Open

Interactive tutorial for building interactive tutorials #1005

jverkoey opened this issue Aug 7, 2024 · 0 comments
Labels
enhancement Improvements or enhancements to existing functionality

Comments

@jverkoey
Copy link

jverkoey commented Aug 7, 2024

Feature Name

Interactive tutorials

Description

https://www.swift.org/documentation/docc/building-an-interactive-tutorial introduces a ton of concepts in somewhat of a "and then draw the owl" fashion. This feels like a perfect place where an interactive tutorial on how to create interactive tutorials would be helpful (albeit a bit meta).

Some unsolicited feedback:

  • Having to provide an @Image for every directive makes it really hard to progressively build out the tutorial. Similarly for @Chapter requiring at least one @TutorialReference. Perhaps the order of operations is that you're supposed to write a tutorial first, and then write the table of contents? If this is the case, then https://www.swift.org/documentation/docc/building-an-interactive-tutorial is explaining things in the opposite order.

Motivation

I am trying to write an interactive tutorial for Slipstream (http://github.com/jverkoey/slipstream/).

Importance

Primarily important for teaching developers how to make interactive tutorials for their own frameworks. Doing so would improve the quality of documentation across the Apple developer community, in turn making development on Apple platforms more enjoyable for all <3

Alternatives Considered

No response

@jverkoey jverkoey added the enhancement Improvements or enhancements to existing functionality label Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvements or enhancements to existing functionality
Projects
None yet
Development

No branches or pull requests

1 participant