Skip to content

Conversation

@codefiesta
Copy link
Owner

@codefiesta codefiesta commented Jul 3, 2025

Description

Swift DocC generation with Github workflow.

  • Adds spi.yml for Swift Package Index to reference documentation.
  • Added docc.yml workflow for auto generating and publishing docs to Github pages.
  • Added OAuthKit.docc markdown files for rich Swift documentation.

Type of change

  • 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 not work as expected)
  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@codefiesta codefiesta self-assigned this Jul 3, 2025
@codefiesta codefiesta added documentation Improvements or additions to documentation workflow Workflow action update labels Jul 3, 2025
@codefiesta codefiesta changed the title [WIP] Swift DocC Swift DocC Jul 3, 2025
@codefiesta codefiesta marked this pull request as ready for review July 3, 2025 04:14
@codefiesta codefiesta merged commit 93ab17f into main Jul 3, 2025
3 checks passed
@codefiesta codefiesta deleted the swift_docC branch July 3, 2025 04:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation workflow Workflow action update

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants