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

Swift docc 💡 #105

Merged
merged 1 commit into from
Oct 13, 2024
Merged

Swift docc 💡 #105

merged 1 commit into from
Oct 13, 2024

Conversation

chicio
Copy link
Owner

@chicio chicio commented Oct 13, 2024

Migration from jazzy to Swift docc

Description

Documentation is now generated using swift docc

Motivation and Context

Jazzy is unreliable. Use swift docc for being able to better customize the documentation with example and deep linking.

How Has This Been Tested?

Doc generation locally

Types of changes

  • Bug fix 🐛 (non-breaking change which fixes an issue)
  • New feature ✨ (non-breaking change which adds functionality)
  • Breaking change 💥 (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project 🍻.
  • My change requires a change to the documentation 💡 and I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document 👥.
  • I have added tests to cover my changes 🎉.
  • All new and existing tests passed ✅.

@chicio chicio self-assigned this Oct 13, 2024
@chicio chicio merged commit ff9f4b1 into main Oct 13, 2024
10 checks passed
@chicio chicio deleted the docc branch October 13, 2024 11:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant