Skip to content

API Reference #41

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

Merged
merged 22 commits into from
Apr 30, 2025
Merged

API Reference #41

merged 22 commits into from
Apr 30, 2025

Conversation

stevensJourney
Copy link
Contributor

@stevensJourney stevensJourney commented Apr 24, 2025

Overview

This adds a basic automatically generated API reference for the Swift SDK.

Docs are generated with XCode's docbuild command.

Docs are deployed at https://powersync-ja.github.io/powersync-swift

Docs and other SwiftDoc comments will be updated as future work.

image

@stevensJourney stevensJourney marked this pull request as ready for review April 30, 2025 07:37
@stevensJourney stevensJourney requested a review from Copilot April 30, 2025 07:37
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds an automatically generated API reference for the Swift SDK by introducing a new GitHub Actions workflow that builds, processes, and deploys documentation to GitHub Pages.

  • Introduces a workflow (docs.yaml) for building and deploying Swift SDK docs.
  • Uses xcodebuild and xcrun docc commands to generate and process documentation.

rkistner
rkistner previously approved these changes Apr 30, 2025
@stevensJourney stevensJourney merged commit adc7648 into main Apr 30, 2025
4 checks passed
@stevensJourney stevensJourney deleted the test-docs branch April 30, 2025 14:58
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.

2 participants