Nimble's documentation was previously mostly in the README. Jesse Squires helped a lot by adding autogenerated docs using Jazzy, but that didn't fix the problem of the giant README, that includes installation instructions at the bottom.
DocC is not as nice as Jazzy for autogenerated docs, but for human-written documentation, it's pretty nice. 8/10. This PR migrates our documentation to DocC, for easier consumption.
There's a lot of follow-up work after this is done to further improve Nimble's documentation, but this is an great starting point just in terms of improving the chances that people's eyes won't glaze over at the giant README.
This PR doesn't require a new version of Nimble to go out.
Nimble's documentation was previously mostly in the README. Jesse Squires helped a lot by adding autogenerated docs using Jazzy, but that didn't fix the problem of the giant README, that includes installation instructions at the bottom.
DocC is not as nice as Jazzy for autogenerated docs, but for human-written documentation, it's pretty nice. 8/10. This PR migrates our documentation to DocC, for easier consumption.
There's a lot of follow-up work after this is done to further improve Nimble's documentation, but this is an great starting point just in terms of improving the chances that people's eyes won't glaze over at the giant README.