Skip to content

Documentation for other platforms than macOS #4

Description

@mahal

Description

At the moment, all documentation on audiokit.io is referencing to macOS. Example: https://www.audiokit.io/AudioKitUI/documentation/audiokitui/adsrview inherits from AppKit.NSView

Proposed Solution

It would be helpful to either choose platform or mark availability on each class / struct.

Describe Alternatives You've Considered

I've tried to build the documentation with docc for iOS, which would be in my case a bit more helpful than macOS but swift-docc-plugin doesn't support choosing the platform:
swiftlang/swift-docc-plugin#38

I've considered other means of generating the documentation as described in https://danielsaidi.com/blog/2022/04/27/building-multi-platform-documentation-with-docc

It looks a bit overwhelming to migrate to xcodebuild docbuild or to implement something new and integrate it into the existing CI flow

Additional Context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions