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.

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

Improve DocC landing pages #313

Merged
merged 4 commits into from
Dec 16, 2024
Merged

Improve DocC landing pages #313

merged 4 commits into from
Dec 16, 2024

Conversation

fpseverino
Copy link
Contributor

Improve DocC landing pages by mimicking Apple's CryptoKit docs

Checklist

  • I've run tests to see all new and existing tests pass
  • I've followed the code style of the rest of the project
  • I've read the Contribution Guidelines
  • I've updated the documentation if necessary

If you've made changes to gyb files

  • I've run .script/generate_boilerplate_files_with_gyb and included updated generated files in a commit of this pull request

Motivation:

Right now the DocC docs group all APIs by protocols, structures and enums.
By adding a topics section in the landing page we can group them by type ("Ciphers", "Public key cryptography", etc.) exactly in the way Apple does in CryptoKit docs.

Modifications:

  • Fix DocC compilation errors in _CryptoExtras
  • Add topics section in _CryptoExtras landing page
  • Add topics section in Crypto landing page

Result:

APIs will be grouped by type.

@Lukasa Lukasa added the semver/none No version bump required. label Dec 16, 2024
Copy link
Contributor

@Lukasa Lukasa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really nice @fpseverino, thanks!

@Lukasa Lukasa enabled auto-merge (squash) December 16, 2024 12:48
@Lukasa Lukasa disabled auto-merge December 16, 2024 12:48
@Lukasa Lukasa enabled auto-merge (squash) December 16, 2024 12:48
@Lukasa Lukasa merged commit 0bf9f47 into apple:main Dec 16, 2024
33 checks passed
@fpseverino fpseverino deleted the docc branch December 16, 2024 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver/none No version bump required.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants