Adds documentation curation, enables documentation on SPI

mergesort / Boutique

✨ A magical persistence library (and so much more) for state-driven iOS and Mac apps ✨

https://build.ms/boutique/docs

MIT License

899 stars 43 forks source link

Adds documentation curation, enables documentation on SPI #11

Closed icanzilb closed 2 years ago

icanzilb commented 2 years ago

The code already included plenty of in-source docs so this PR:

adds DocC curation so documentation is easy to navigate in Xcode and on the web
cleans up a few in-source doc comments so they render nicely as documentation
adds a config file so SwiftPackageIndex can automatically publish the documentation online

Here are some screenshots of the results:

landing page

store page

getting started

mergesort commented 2 years ago

Thank you so much for these changes @icanzilb! This is great, and I appreciate you taking the time to teach me more in depth about docc, I'll make sure that future work uses it. 🙇🏻‍♂️