Skip to content

Interactive tutorial for building interactive tutorials #1005

Open
@jverkoey

Description

@jverkoey

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementImprovements or enhancements to existing functionality

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions