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

Documentation for other platforms than macOS #4

Open
mahal opened this issue Apr 10, 2024 · 1 comment
Open

Documentation for other platforms than macOS #4

mahal opened this issue Apr 10, 2024 · 1 comment

Comments

@mahal
Copy link
Contributor

mahal commented Apr 10, 2024

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

@mahal mahal changed the title Documentation also for other platforms than macOS Documentation for other platforms than macOS Apr 10, 2024
@mahal
Copy link
Contributor Author

mahal commented Apr 10, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant