Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Provide some docs #273

Open
0xTim opened this issue Oct 12, 2024 · 1 comment · May be fixed by #283
Open

Provide some docs #273

0xTim opened this issue Oct 12, 2024 · 1 comment · May be fixed by #283
Labels
area/documentation Improvements or additions to documentation. good first issue Good for newcomers

Comments

@0xTim
Copy link
Contributor

0xTim commented Oct 12, 2024

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
Copy link
Collaborator

Lukasa commented Oct 14, 2024

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.

@Lukasa Lukasa added area/documentation Improvements or additions to documentation. good first issue Good for newcomers labels Oct 14, 2024
@0xTim 0xTim linked a pull request Oct 16, 2024 that will close this issue
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/documentation Improvements or additions to documentation. good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add Intial DocC docs 0xTim/swift-crypto
2 participants
@Lukasa @0xTim