SwiftPackageIndex-Server

SwiftPackageIndex-Server copied to clipboard

Is this based purely on the existence of the configuration, or a value of how well it's documented? (A crude example being % of public interface documented)

Jun 07 '22 18:06 Sherlouk

My plan was to base it on neither of those things initially. Obviously, documentation coverage would be better than the existence of the configuration but we don't have that and I don't think we should delay boosting the score until (or if) we solve that problem.

#1784 adds a new field versions.doc_archives which is updated when the configuration is there and docs get successfully generated. I plan to use that to gate these points initially.

Jun 07 '22 20:06 daveverwer

what if a package has documentation hosted elsewhere?

Jun 14 '22 18:06 tayloraswift

@kelvin13 I suspect that as long as it has the means to generate documentation w/ DocC, even if it's already hosted elsewhere, the flag would get triggered by the SPI build system. I don't think (or see) anything that manually turns it on - if it's there, it gets built, and if it gets built, that flag gets set.

Jul 14 '22 00:07 heckj

We have plans to allow authors to configure an external doc url via the .spi.yml file. I imagine we'll treat the presence of that url the same way as SPI hosted docs, allowing authors to easily opt-in via that path as well.

Jul 14 '22 05:07 finestructure

We've had "plans" for a while now but they've not been written down anywhere. Now they are! https://github.com/SwiftPackageIndex/SwiftPackageIndex-Server/issues/1894

One step closer! 😅

Jul 14 '22 07:07 daveverwer