swift-nio icon indicating copy to clipboard operation
swift-nio copied to clipboard

Adopt DocC documentation if possible

Open Lukasa opened this issue 4 years ago • 4 comments

The various SwiftNIO projects should consider adopting the newly released DocC formats.

Lukasa avatar Jun 08 '21 09:06 Lukasa

Still catching up to the wwdc info dump, but haven’t seen any mentions of SPM / DocC integration - so what gives for doc generation without Xcode in that case? Perhaps that’ll happen as part of the open sourcing later this year with some luck .

hassila avatar Jun 09 '21 13:06 hassila

Great question, to which I don't have the answer. @tomerd will likely know better whether this is something that we can actually action now, but we definitely should add some narrative documentation somewhere and I'd love to not need multiple formats.

Lukasa avatar Jun 09 '21 16:06 Lukasa

once DocC is open source the rest of the pieces can start falling into place

tomerd avatar Jun 09 '21 16:06 tomerd

Still catching up to the wwdc info dump, but haven’t seen any mentions of SPM / DocC integration - so what gives for doc generation without Xcode in that case? Perhaps that’ll happen as part of the open sourcing later this year with some luck .

FWIW DocC does support SPM though the integration documentation is a little light. I have an example repo, dm me for more details :).

rauhul avatar Jul 04 '21 00:07 rauhul