apple / swift-collections-benchmark

A benchmarking tool for Swift Collection algorithms
Apache License 2.0
340 stars 23 forks source link

Host Documentation on Swift Package Index #22

Open DandyLyons opened 1 month ago

DandyLyons commented 1 month ago

I've added a simple SPI manifest so that SPI can build and host the DocC documentation. For context see: https://swiftpackageindex.com/SwiftPackageIndex/SPIManifest/~/documentation/spimanifest/commonusecases#spiHosting

Room For Further Improvement

This PR only adds SPI doc hosting. It makes no changes to the DocC itself.

Currently, this DocC documentation does not include articles like the contents of the Documentation directory, including the Getting Started.md.

It would be valuable to include that in the DocC as well. I can do that in a future commit if you like. I just wanted to confirm the structure of how you all would like to do it.

After SPI builds and hosts the documentation, it would be good to add that URL to the README, to make it easier to find.

Checklist