Skip to content

Documentation Source Links#118

Merged
codefiesta merged 8 commits into
mainfrom
docc_src_links
Jul 8, 2025
Merged

Documentation Source Links#118
codefiesta merged 8 commits into
mainfrom
docc_src_links

Conversation

@codefiesta

Copy link
Copy Markdown
Owner

Description

The Swift DocC workflow (docc.yml) file now uses the swift-docc-plugin to generate documentation instead of using xcodebuild docbuild command.

The advantage of using this over the xcodebuild docbuild command is that we can now link source files directly to the generated documentation.

Before After
before after

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 8, 2025
@codefiesta codefiesta added documentation Improvements or additions to documentation workflow Workflow action update labels Jul 8, 2025
@codefiesta codefiesta marked this pull request as ready for review July 8, 2025 19:28
@codefiesta codefiesta merged commit 3144afc into main Jul 8, 2025
2 checks passed
@codefiesta codefiesta deleted the docc_src_links branch July 8, 2025 20:07
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.

1 participant