Add LiveObjects product to site navigation by VeskeR · Pull Request #2464 · ably/docs

VeskeR · 2025-03-05T09:20:09Z

Description

Adds navigation for LiveObjects product in src folder.

This was added by searching for "livesync" in "src" folder and adding corresponding "liveObjects" sections where necessary.

Currently missing:

Need a png for main docs page for LiveObjects https://github.com/ably/docs/pull/2464/files#diff-74d9b85d26804605bb64641c8787195382c4dc7674c01c5fd5c1716fe168144dR60
Need LiveObjects icons for docs navigation https://github.com/ably/docs/pull/2464/files#diff-39bc77ddcd9f663f1666da2e0f9a528358251e8f7285384b8f53c47845b06075R7-R8

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-03-05T09:20:16Z

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.
- Generate unit testing code for this file.
- 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 generate unit testing code for this file.
- @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 generate unit testing code.
- @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.

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 resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@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.

VeskeR · 2025-03-07T09:21:18Z

+ title: 'LiveObjects',
+ type: 'feature',
+ content: 'Seamlessly sync application state between clients.',
+ image: 'liveobjects.png',


this needs to be added

tracking in https://ably.atlassian.net/browse/PUB-1589, might end up not needing this

VeskeR · 2025-03-07T09:22:14Z

 react: 0.4,
 },
+ liveObjects: {
+ javascript: 2.6,


not sure about this one. LiveObjects is not a separate product, so it doesn't have its own versioning.
will it inherit the pub/sub SDKs version then? e.g. 2.6 for ably-js
cc @mschristensen

Yes I think we should just specify the Ably JS version

ok, works for me.
Also, technically, it wouldn't be 2.6, as with the liveobjects release we will bump the minor version in ably-js to at least 2.7 (or more if other versions released before that).
@ably/team-deved would you guys prefer:
this PR to have 2.6 version in this PR, and then open a second PR to update the ably-js versions for all products (not just liveobjects) to higher version once it's published
keep this PR open until ably-js is published and change the version here to the actual one, as well as for other products?

Assuming that LiveObjects is the only change going into 2.7 of ably-js then I think we can just bump both of them to 2.7 in this PR.

sgtm, I've preemptively updated it to 2.7 for everything, but will change it again if we end up releasing liveobjects under another minor ably-js version

mschristensen · 2025-03-07T16:44:13Z

Looks good, we just need some assets from the design team - I'll follow up with Jamie

VeskeR · 2025-03-11T08:47:37Z

I've removed the Setup page as we decided to drop it in favor of Quickstart: #2463 (comment)

m-hulbert · 2025-03-17T14:31:24Z

 react: 0.4,
 },
+ liveObjects: {
+ javascript: 2.6,


Assuming that LiveObjects is the only change going into 2.7 of ably-js then I think we can just bump both of them to 2.7 in this PR.

m-hulbert · 2025-03-17T14:33:08Z

+ name: 'Batch Operations',
+ link: '/docs/liveobjects/batch',
+ },
+ {
+ name: 'Lifecycle Events',
+ link: '/docs/liveobjects/lifecycle',
+ },
+ {
+ name: 'Typing',
+ link: '/docs/liveobjects/typing',


As per my review on the main PR; I wonder if the features should remain only LiveCounter and LiveMap, and then these 3 items fall under a separate heading. Any thoughts?

then these 3 items fall under a separate heading. Any thoughts?
Not against putting them under a separate heading. Honestly, they're under LiveObjects features heading right now because I couldn't think of another collective name for these three.
Any ideas?

Maybe something like 'Advanced', or 'Advanced usage'?
I think they should be separated in all honesty, but also struggling with the correct terminology.

Created https://ably.atlassian.net/browse/PUB-1588 to give it another thought later, don't want to block this PR right now

This was added by searching for "livesync" in "src" folder and adding corresponding "liveObjects" sections where necessary.

m-hulbert

LGTM

/docs/liveobjects added in #2464

VeskeR requested a review from a teamMarch 5, 2025 09:20

ably-ci temporarily deployed to ably-docs-liveobjects-n-jiwpew March 5, 2025 09:20 Inactive

VeskeR mentioned this pull request Mar 5, 2025
[PUB-773] LiveObjects product docs #2463
Merged
11 tasks

VeskeR force-pushed the liveobjects-navigation branch from 9ac84e8 to e5e6eceCompare March 5, 2025 09:26

VeskeR force-pushed the PUB-773/liveobjects-product-docs branch from 3bfe8d2 to 145457eCompare March 5, 2025 09:31

VeskeR force-pushed the liveobjects-navigation branch from e5e6ece to 48b36e8Compare March 5, 2025 09:41

m-hulbert temporarily deployed to ably-docs-liveobjects-n-jiwpew March 5, 2025 09:50 Inactive

VeskeR force-pushed the PUB-773/liveobjects-product-docs branch from 145457e to 5d95e7fCompare March 6, 2025 09:15

VeskeR force-pushed the liveobjects-navigation branch from 48b36e8 to c284b79Compare March 6, 2025 09:16

VeskeR force-pushed the PUB-773/liveobjects-product-docs branch from 5d95e7f to 1f7289eCompare March 7, 2025 09:10

VeskeR force-pushed the liveobjects-navigation branch from c284b79 to 4c70358Compare March 7, 2025 09:16

VeskeR force-pushed the PUB-773/liveobjects-product-docs branch from 1f7289e to 2f870cdCompare March 7, 2025 09:18

VeskeR force-pushed the liveobjects-navigation branch from 4c70358 to 8b99a80Compare March 7, 2025 09:18

VeskeR commented Mar 7, 2025
View reviewed changes

Comment threadsrc/data/nav/liveobjects.ts

VeskeR commented Mar 7, 2025
View reviewed changes

VeskeR marked this pull request as ready for review March 7, 2025 09:22

GregHolmes temporarily deployed to ably-docs-liveobjects-n-jiwpew March 7, 2025 09:35 Inactive

VeskeR force-pushed the PUB-773/liveobjects-product-docs branch 2 times, most recently from 7c9bad3 to 25b2298Compare March 11, 2025 08:24

VeskeR force-pushed the liveobjects-navigation branch 2 times, most recently from f674eaa to 28b40a7Compare March 11, 2025 08:47

m-hulbert temporarily deployed to ably-docs-liveobjects-n-jiwpew March 12, 2025 08:56 Inactive

m-hulbert reviewed Mar 17, 2025
View reviewed changes

VeskeR force-pushed the PUB-773/liveobjects-product-docs branch from 25b2298 to 453be49Compare March 18, 2025 09:14

VeskeR force-pushed the liveobjects-navigation branch from 28b40a7 to 266f785Compare March 18, 2025 09:15

VeskeR force-pushed the PUB-773/liveobjects-product-docs branch from 70e3d74 to 0d1c04bCompare March 18, 2025 09:39

VeskeR force-pushed the liveobjects-navigation branch 2 times, most recently from 1fc1b12 to 20ad800Compare March 19, 2025 08:04

VeskeR requested a review from m-hulbert March 19, 2025 08:07

m-hulbert temporarily deployed to ably-docs-liveobjects-n-ve3wrp March 20, 2025 11:05 Inactive

VeskeR force-pushed the PUB-773/liveobjects-product-docs branch from 0d1c04b to e5f84cfCompare March 25, 2025 07:24

VeskeR force-pushed the liveobjects-navigation branch from 20ad800 to a9b4071Compare March 25, 2025 07:24

Add LiveObjects product to site navigation
6d37df9
This was added by searching for "livesync" in "src" folder and adding corresponding "liveObjects" sections where necessary.

VeskeR force-pushed the liveobjects-navigation branch from a9b4071 to 6d37df9Compare March 25, 2025 07:26

VeskeR changed the base branch from PUB-773/liveobjects-product-docs to integration/liveobjectsMarch 25, 2025 07:27

m-hulbert temporarily deployed to ably-docs-liveobjects-n-kfbfhb March 28, 2025 14:40 Inactive

m-hulbert approved these changes Mar 28, 2025
View reviewed changes

mschristensen added a commit that referenced this pull request Mar 31, 2025
liveobjects: objects message excluded from storage
8e9f0b9
/docs/liveobjects added in #2464

VeskeR merged commit ffc792f into integration/liveobjectsApr 2, 2025

VeskeR deleted the liveobjects-navigation branch April 2, 2025 07:18

mschristensen added a commit that referenced this pull request Apr 2, 2025
liveobjects: objects message excluded from storage
60f873c
/docs/liveobjects added in #2464

mschristensen added a commit that referenced this pull request Apr 2, 2025
liveobjects: objects message excluded from storage
4ed1083
/docs/liveobjects added in #2464

VeskeR mentioned this pull request Apr 11, 2025
[PUB-1588] Add Advanced section for some of the LiveObjects navigation items #2522
Merged
3 tasks

VeskeR pushed a commit that referenced this pull request Apr 11, 2025
liveobjects: objects message excluded from storage
d6d5223
/docs/liveobjects added in #2464

VeskeR mentioned this pull request Apr 17, 2025
Merge integration/liveobjects into main#2541
Merged
3 tasks

GregHolmes pushed a commit that referenced this pull request Apr 25, 2025
liveobjects: objects message excluded from storage
83667c7
/docs/liveobjects added in #2464

mschristensen added a commit that referenced this pull request Apr 28, 2025
liveobjects: objects message excluded from storage
f48324d
/docs/liveobjects added in #2464

Uh oh!

Conversation

VeskeR commented Mar 5, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

coderabbitaiBot commented Mar 5, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Chat

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!

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!

VeskeRMar 19, 2025• 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!

mschristensen commented Mar 7, 2025

Uh oh!

VeskeR commented Mar 11, 2025

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!

m-hulbert left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

5 participants

VeskeR commented Mar 5, 2025•
edited
Loading

coderabbitaiBot commented Mar 5, 2025•
edited
Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

VeskeRMar 19, 2025•
edited
Loading