Adds getting started links

[franrob-projects]

This PR:

• Replaces quickstart link with the getting started guide
• Adds Live Objects documentation link
• Fixs platform table spacing and changelog path
• Streamlines example app section structure

Summary by CodeRabbit

• Documentation
  • Updated Getting Started guidance, replacing Quickstart with a link to Java setup.
  • Enhanced Live Objects section: renamed install header, added direct link, restructured examples, and now highlights both Color Voting and Task Management, with instructions to run the example app.
  • Added a collapsible Proxy support setup guide with dependency and usage examples.
  • Improved Android labeling and various formatting for clarity.
  • Updated CHANGELOG link to a relative path.

[coderabbitai]

Walkthrough

Docs-only updates to README.md: reorganized sections, updated links, renamed headers, added a proxy setup collapsible block with OkHttp example, consolidated example references, and adjusted formatting. The CHANGELOG link is now relative, and an explicit instruction to run the example app was added.

Changes

Cohort / File(s)

Summary

Docs: README updates README.md

Replaced Quickstart with Getting Started link to /docs/getting-started/java; tweaked Android table label; added Ably Live Objects hyperlink; renamed “Installation” to “Install Live Objects”; restructured Live Objects docs into an Example app section; merged example bullets into a single sentence referencing Color Voting and Task Management with examples README link; added a collapsible Proxy support setup block with OkHttp dependency and usage sample; changed CHANGELOG link to relative; added instruction to run the example app; minor formatting updates (bullets, links).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I nudge the docs with a whisker’s sweep,
New links hop in, old paths leap.
Proxy trails marked, OkHttp in tow,
Live Objects shine with a gentle glow.
“Run the app!” I thump with cheer—
Changelog close, no detours here. 🐇📘

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch Adds-getting-started-links-new

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbit in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbit 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:
  • @coderabbit gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbit read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbit help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbit ignore or @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbit summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbit or @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

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• 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.

[coderabbitai]

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

README.md (1)

110-118: Fix README Live Objects dependency coordinate

io.ably:liveobjects isn’t published on Maven Central. Replace the runtimeOnly("io.ably:liveobjects:1.2.54") entry with an implementation dependency using the actual Ably Java artifact (e.g. io.ably:ably-java:<latest-version>), and verify the correct version on Maven Central.

🧹 Nitpick comments (2)

README.md (2)

108-108: Subject–verb agreement in product sentence.

Use singular verb form with the product name.

Apply:

-[Ably Live Objects](https://ably.com/docs/liveobjects) provide realtime, collaborative data structures...
+[Ably Live Objects](https://ably.com/docs/liveobjects) provides realtime, collaborative data structures...

---

200-200: Relative CHANGELOG link: nice; minor style nit.

Drop the extra “also” for tighter prose.

-The [CHANGELOG.md](./CHANGELOG.md) contains details of the latest releases for this SDK. You can also view all Ably releases on [changelog.ably.com](https://changelog.ably.com).
+The [CHANGELOG.md](./CHANGELOG.md) contains details of the latest releases for this SDK. You can view all Ably releases on [changelog.ably.com](https://changelog.ably.com).

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between f94b846 and f1cd596.

📒 Files selected for processing (1)

• README.md (5 hunks)

🧰 Additional context used

🧠 Learnings (2)

📚 Learning: 2025-06-05T10:27:53.946Z

Learnt from: sacOO7
PR: ably/ably-java#1095
File: gradle/libs.versions.toml:24-26
Timestamp: 2025-06-05T10:27:53.946Z
Learning: The ably-java project prefers to use the latest available versions of testing dependencies (including pre-release versions) when they contain relevant bug fixes, rather than sticking strictly to stable releases.

Applied to files:

• README.md

📚 Learning: 2025-08-19T10:42:35.254Z

Learnt from: sacOO7
PR: ably/ably-java#1151
File: lib/src/main/java/io/ably/lib/objects/type/counter/LiveCounter.java:15-15
Timestamp: 2025-08-19T10:42:35.254Z
Learning: The ably-java library has not had any official releases yet, so breaking changes to public APIs (like adding new abstract methods to interfaces) are acceptable during the pre-release development phase.

Applied to files:

• README.md

🪛 LanguageTool

README.md

[style] ~200-~200: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...so view all Ably releases on changelog.ably.com. --- ...

(ADVERB_REPETITION_PREMIUM)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (12)

• GitHub Check: check (21)
• GitHub Check: check (29)
• GitHub Check: check (24)
• GitHub Check: check (19)
• GitHub Check: check
• GitHub Check: check-realtime
• GitHub Check: build
• GitHub Check: check-rest-okhttp
• GitHub Check: check (29)
• GitHub Check: check-liveobjects
• GitHub Check: check-realtime-okhttp
• GitHub Check: check-rest

🔇 Additional comments (3)

README.md (3)

22-22: Good swap to canonical “Getting started” doc.

Accurate and clearer entry point for new users.

---

120-123: Verified examples directory and README references: ./examples directory and examples/README.md are present, and the README includes both Color Voting and Task Management examples.

---

37-37: Apply spacing fix on Android row (minimum API 19 confirmed)
API level 19 (Android 4.4 KitKat) remains the supported minimum. Update spacing for consistency:

-| Android  | >=4.4 (API level 19) |
+| Android  | >= 4.4 (API level 19) |

[sacOO7]

LGTM

[ttypic]

LGTM