search

AudioKit / audiokit.io

Website for AudioKit documentation.
https://audiokit.io
MIT License
4 stars 2 forks source link

Documentation for other platforms than macOS #4

Open mahal opened 4 months ago

mahal commented 4 months ago

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: https://github.com/apple/swift-docc-plugin/issues/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

mahal commented 4 months ago

As a workaround: Add a .docc to each framework, build documentation manually in Xcode, export it and create a PR here.