[ECO-5267] Swift pub/sub getting started #2620

umair-ably · 2025-05-19T22:51:35Z

Description

Adds Swift getting started guide for pub/sub

Checklist

Commits have been rebased.
Linting has been run against the changed file(s).
The PR adheres to the writing style guide and contribution guide.

coderabbitai · 2025-05-19T22:51:42Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

ttypic · 2025-05-27T07:58:16Z

content/getting-started/swift.textile

+```
+
+* Install "Xcode":https://developer.apple.com/xcode/
+


Maybe add a step to create a new Swift project before installing the Ably SDK?

ttypic · 2025-05-27T08:03:31Z

content/getting-started/swift.textile

+    print("Connection state changed to: \(stateChange.current)")
+
+    if stateChange.current == .connected {
+        print("Made my first connection!")


On one hand, I think we shouldn't overcomplicate things; on the other hand, printing to the console in a SwiftUI project feels a bit out of place. Maybe we can create simple in-app console (just render list of lines in a text box)? Or maybe create console desktop swift app instead of swift ui?

franrob-projects

This worked fine for me :). I did need to look elsewhere for help during the initial file setup in Xcode - - though that’s partly a knowledge issue because I’m not a Swift dev.

.... But I'm happy to approve this doc if we’re all happy with the content -- but with formatting fixes needed!

I left a comment at the beginning regarding formatting — it applies throughout the doc. I’m also happy to pick this up and give it a quick tidy-up (and add any more setup info) if that’s helpful!!??

franrob-projects · 2025-05-29T15:14:07Z

content/getting-started/swift.textile

+
+* Open up the "dev console":https://ably.com/accounts/any/apps/any/console of your first app before instantiating your client so that you can see what happens.
+
+* Add these imports to the top of your Swift file:


Which Swift file, @ContentView.swift@?

Add "the following" imports to the top of your Swift file:

franrob-projects · 2025-05-29T16:00:17Z

content/getting-started/swift.textile

+<p><strong>Important:</strong> API keys are suitable for development and demo purposes only. For production apps, <a href="/docs/authentication/token-authentication">use token authentication</a> to keep your credentials secure.</p>
+</aside>
+
+h2(#xcode-setup). Running this example in Xcode (SwiftUI)


Make this h3

franrob-projects · 2025-05-29T16:02:37Z

content/getting-started/swift.textile

+
+<aside data-type='note'>
+<p>The code examples in this guide include a demo API key. If you wish to interact with the Ably CLI and view outputs within your Ably account, ensure that you replace them with your own API key.</p>
+<p><strong>Important:</strong> API keys are suitable for development and demo purposes only. For production apps, <a href="/docs/authentication/token-authentication">use token authentication</a> to keep your credentials secure.</p>


Maybe separate these :)

franrob-projects · 2025-05-29T16:06:07Z

content/getting-started/swift.textile

+
+Clients establish a connection with Ably when they instantiate an SDK. This enables them to send and receive messages in realtime across channels.
+
+* Open up the "dev console":https://ably.com/accounts/any/apps/any/console of your first app before instantiating your client so that you can see what happens.


Maybe just a re-jig with the way we are using bullets

Swift pub/sub getting started

4434a0a

umair-ably requested a review from m-hulbert May 19, 2025 22:51

jamienewcomb requested a review from ttypic May 23, 2025 13:50

ttypic reviewed May 27, 2025

View reviewed changes

franrob-projects temporarily deployed to ably-docs-eco-5267-bqos9wybbav May 29, 2025 13:23 Inactive

franrob-projects self-requested a review May 29, 2025 15:10

franrob-projects approved these changes May 29, 2025

View reviewed changes

franrob-projects self-requested a review May 29, 2025 16:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[ECO-5267] Swift pub/sub getting started #2620

[ECO-5267] Swift pub/sub getting started #2620

Uh oh!

umair-ably commented May 19, 2025

Uh oh!

coderabbitai bot commented May 19, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

ttypic May 27, 2025

Uh oh!

franrob-projects May 29, 2025

Uh oh!

ttypic May 27, 2025

Uh oh!

franrob-projects left a comment •

edited

Loading

Uh oh!

franrob-projects May 29, 2025

Uh oh!

franrob-projects May 29, 2025

Uh oh!

franrob-projects May 29, 2025

Uh oh!

franrob-projects May 29, 2025

Uh oh!

franrob-projects May 29, 2025

Uh oh!

Uh oh!


		* Open up the "dev console":https://ably.com/accounts/any/apps/any/console of your first app before instantiating your client so that you can see what happens.

		* Add these imports to the top of your Swift file:


		Clients establish a connection with Ably when they instantiate an SDK. This enables them to send and receive messages in realtime across channels.

		* Open up the "dev console":https://ably.com/accounts/any/apps/any/console of your first app before instantiating your client so that you can see what happens.

[ECO-5267] Swift pub/sub getting started #2620

Are you sure you want to change the base?

[ECO-5267] Swift pub/sub getting started #2620

Uh oh!

Conversation

umair-ably commented May 19, 2025

Description

Checklist

Uh oh!

coderabbitai bot commented May 19, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

franrob-projects left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

CodeRabbit Configuration File (`.coderabbit.yaml`)

franrob-projects left a comment •

edited

Loading