Skip to content

Update supported platforms and outdated install notes - #2345

Merged
maratal merged 1 commit into
mainfrom
docs/readme-supported-platforms
Oct 30, 2026
Merged

maratal merged 1 commit into
mainfrom
docs/readme-supported-platforms

Conversation

@maratal

@maratal maratal commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

Updates docs that still described 1.x.

  • README and LiveObjects README: the supported platforms are iOS 15, macOS 12 and tvOS 15, matching Package.swift. They listed 14, 11 and 14.
  • README:
    • The note that versions below 1.2.23 would be deprecated from November 2025 is removed.
    • The installation section now mentions tvOS, and the Xcode steps use File → Add Package Dependencies….
  • Issue template:
    • It asks how the SDK was installed rather than whether Carthage or CocoaPods is used. Those two remain as answers for 1.x.
    • The examples now show 2.0.0 and iOS 26.
    • The debug tip uses clientOptions.logLevel, since realtime.logger isn't public API in 2.0.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the documented minimum supported versions to iOS 15, macOS 12, and tvOS 15, and added tvOS installation instructions.
    • Revised Swift Package Manager setup steps to match Xcode’s current workflow.
    • Updated issue-reporting examples and installation guidance, and corrected the logging tip.
    • Removed the notice about deprecation of Cocoa SDK versions below 1.2.23.

The READMEs list iOS 15, macOS 12 and tvOS 15, as Package.swift does.
The README drops the note on 1.2.23's deprecation, and the issue
template asks how the SDK was installed instead of about Carthage and
CocoaPods.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 31bfe761-8ec5-4c2c-a6b9-d32adc394783
Commits

Reviewing files that changed from the base of the PR and between 4fd3563 and 91f89c0.

Files selected for processing: 3
  • .github/issue_template.md
  • LiveObjects/README.md
  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The README files now document higher minimum platform versions. The main README updates Swift Package Manager instructions and adds tvOS to installation guidance. The issue template updates its version and platform examples, installation question, and logging tip.

Changes

SDK documentation

Layer / File(s) Summary
Platform and installation documentation
README.md, LiveObjects/README.md
The README files now state minimum versions of iOS 15, macOS 12, and tvOS 15. The main README updates Swift Package Manager instructions, adds tvOS to installation guidance, and removes the deprecation notice for versions below 1.2.23.
Issue template guidance
.github/issue_template.md
The template updates its SDK and platform examples, replaces separate Carthage and CocoaPods questions with an installation-method question, and changes the logging tip to use clientOptions.logLevel.

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Possibly related PRs

Suggested reviewers: sacoo7, ttypic

Merge Risk: Minimal · up to 91f89

These documentation updates present no identified merge-blocking risk and are ready to merge after normal checks.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main documentation changes: supported platform updates and replacement of outdated installation notes.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)

Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

A rabbit reads the platform guide,
Then checks the package steps inside.
The issue form has clearer clues,
With logging tips and updated views.
It hops away beneath the moon,
And nibbles docs beside a spoon.

Comment @coderabbitai help to get the list of available commands.

@ttypic ttypic left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@maratal
maratal merged commit 1b8923b into main Oct 30, 2026
32 checks passed
@maratal
maratal deleted the docs/readme-supported-platforms branch October 30, 2026 22:45

This branch was successfully deployed

4 active deployments
staging/pull/2345/markdown-api-reference — 91f89c06 Deployed Oct 30, 2026 by github-actions[bot]
staging/pull/2345/jazzydoc — 91f89c06 Deployed Oct 30, 2026 by github-actions[bot]
staging/pull/2345/AblyLiveObjects — 91f89c06 Deployed Oct 30, 2026 by github-actions[bot]
staging/pull/2345/features — 91f89c06 Deployed Oct 30, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants