Current state of documentation?
DandyLyons opened this issue · 1 comments
At first I thought there was no documentation for this repo since it's not mentioned in the ReadMe. I see that there used to be documentation on github pages, but that looks inactive now. I did see that swift package index is hosting documentation here, however, it looks like it's missing everything except for the front page.
Finally, I built the documentation for myself in Xcode and discovered that there's already fantastic documentation. You can find it be using Product > Build Documentation then Window > Developer Documentation, or you can also use Xcode 15's new Documentation Preview Assistant.
To help with discoverability, could we please add a link to the documentation in the ReadMe.
Also, could we reach out to swift package index to find out why their documentation hosting is missing pages?
If you want you can assign this to me.
I looked into your .spi.yml file. At a surface level reading, it appears to exactly match the SPI documentation. So I'm not sure what the issue is. They did mention on their podcast that they have been having issues lately. Perhaps this is related.
Their docs say that they have a validation executable to check that the .spi.yml is formatted correctly beforehand. I haven't yet found out where it is or how to use it.
I reached out to them here.