search

apple / swift-crypto

Open-source implementation of a substantial portion of the API of Apple CryptoKit suitable for use on Linux platforms.
https://apple.github.io/swift-crypto
Apache License 2.0
1.46k stars 158 forks source link

Provide some docs #273

Open 0xTim opened 1 week ago

0xTim commented 1 week ago

New API Proposal: Add Documentation

Motivation:

Currently Swift Crypto offers no documentation site that can be referred to, to see how the API works. There are CryptoKit docs (https://developer.apple.com/documentation/cryptokit) but that can cause confusion for those coming from non-Apple platforms that aren't aware of any differences. Additionally CryptoExtras has no documentation anywhere.

There are DocC comments throughout the files so generating the docs and hosting them on SPI shouldn't be too hard.

Importance:

Documentation helps people understand how to use the package.

Side note

The GH repo points to https://apple.github.io/swift-crypto which is horribly out of date so should be removed until up to date docs are available

Lukasa commented 6 days ago

Thanks, this makes a lot of sense. I think we should begin by producing shell documentation for Crypto that links to the CryptoKit documentation and start some API docs for CryptoExtras. If the community wanted to start with some PRs that added these shells, including an spi.yml, I'd be more than happy to review and merge them.