davedelong / time

Robust and type-safe date and time calculations for Swift
MIT License
2.32k stars 77 forks source link

Add DocC implementation of current docs #59

Closed Mordil closed 3 years ago

Mordil commented 3 years ago

Motivation

DocC is a fantastic tool that was announced at WWDC 2021, and full support was released with Swift 5.5

Supporting documentation within DocC gives additional capabilities to developers who work with Time to have better symbol linking and usage guides available while offline, and generated to render within Xcode itself.

Changes Made

Results

DocC support!

Mordil commented 3 years ago

Here's some screenshots!

Screen Shot 2021-10-30 at 22 39 11 Screen Shot 2021-10-30 at 22 39 47 Screen Shot 2021-10-30 at 22 40 15

Mordil commented 3 years ago

My intention was to just seed the current documentation as DocC for now, leaving the content basically as-is with some early richer linking, and then maybe in a later PR actually editing/re-writing the documentation itself to be more of a first-class citizen as DocC.

I'm not sure how you want to handle the docs at Documentation/.

DocC links (obviously) break when trying to view the markdown in GitHub, so it's a bit substandard to not have a webhosted version of the docs, so I had figured you wanted to keep it as-is until hosting the DocC output