Of Interest: docc support

[thomasvl]

At WWDC2021 docc got announced. The current Makefile has some jazzy support, but might be time to revisit docs flows to instead look at building out docc support instead.

Things that might be needed:

• tweak comments to use code references that link `SYMBOL` to ``SYMBOL``
• Move some of the Documentation/ pages into things included in the built doc set output instead
• Group/categories pages, etc. (see the WWDC videos for improving ones docs).

[jeroenleenarts]

It would be cool if a manifest is added triggering Swift Package Index DocC generation. More info here.

[thomasvl]

I believe they've removed the need for an entry in the Package.swift and all it takes is a .spi.yml entry. That would be fine my me, I was trying to get some time to try generating the docs manually and see if anything needed tweaking before adding the entry, but if you're interested, I'd say go for it!

[jeroenleenarts]

All bits seem to be in place. So I'll ask on the SPI side of things.

[thomasvl]

@tbkka is there anything we can do on CI or manually to validate how we'll we've got things documented? i.e. - missing docs, apis missing params/return result docs/etc.

[thomasvl]

@tbkka should this stay open or get moved to more specific issues for what needs followup?