swiftlang / swift-docc-plugin

Swift Package Manager command plugin for Swift-DocC
https://swiftpackageindex.com/swiftlang/swift-docc-plugin/documentation/swiftdoccplugin
Apache License 2.0
322 stars 53 forks source link

Add package plugin instructions to documentation #9

Closed franklinsch closed 2 years ago

franklinsch commented 2 years ago

Bug/issue #, if applicable: N/A

Summary

Add instructions to set up the plugin in the documentation. When reading the documentation at https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/, it might not be totally clear that the plugin needs to be added to your package first, especially if the developer is not yet familiar with the concept of SwiftPM plugins.

Dependencies

None.

Testing

No functional changes.

Checklist

franklinsch commented 2 years ago

@swift-ci please test

ethan-kusters commented 2 years ago

@swift-ci please test