Skip to content

Feature/pub 1049 pubsub docs liveobjects #2503

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 7 commits into from
Apr 2, 2025
Merged

Feature/pub 1049 pubsub docs liveobjects #2503

merged 7 commits into from
Apr 2, 2025

Conversation

mschristensen
Copy link
Contributor

@mschristensen mschristensen commented Mar 31, 2025 •
edited
Loading

Description

Aligns various changes relating to the LiveObjects feature on the Pub/Sub docs side. Includes:

  • Occupancy metrics
  • Capabilities
  • Modes
  • Stats name changes
  • Max objects limit
  • Exclusion from storage

Checklist

@mschristensen mschristensen requested a review from m-hulbert March 31, 2025 14:09
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Mar 31, 2025

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.

@mschristensen mschristensen requested a review from VeskeR March 31, 2025 14:10
@mschristensen mschristensen mentioned this pull request Mar 31, 2025
Open
11 tasks
VeskeR
VeskeR requested changes Apr 2, 2025
View reviewed changes
Copy link
Contributor

@VeskeR VeskeR left a comment

Choose a reason for hiding this comment

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

Looks good, some minor comments

@VeskeR
Copy link
Contributor

VeskeR commented Apr 2, 2025

Also copy Mark's comment from content PR, might want to address it here:

Yeah, the default modes simplify things from an end-user perspective and that hasn't necessarily been obvious, or an issue until now.
If we're making that distinction between default, and non-default modes more important now, then I think we need to document those in the modes documentation (probably makes sense to do so in #2503).

@mschristensen mschristensen force-pushed the feature/PUB-1049-pubsub-docs-liveobjects branch from 44f6378 to d80d1eb Compare April 2, 2025 09:28
@mschristensen
channels/options: channel modes docs
d1ba32b 
Update the channel modes docs to clarify the distinction between
capabilities and modes, which capabilties grant access to which modes,
the default modes requested by a client if none are explicitly
requested, and how the resulting modes assigned to the client are
determined.

This change is made now in order to clarify the behaviour of the
`OBJECT_*` modes, which are non-default and must be explicitly
requested.
@mschristensen
Copy link
Contributor Author

@m-hulbert Per your comment on #2463 I have updated the channel modes docs in d1ba32b, please take a look

@mschristensen mschristensen requested a review from VeskeR April 2, 2025 10:35
m-hulbert
m-hulbert approved these changes Apr 2, 2025
View reviewed changes
Copy link
Contributor

@m-hulbert m-hulbert left a comment

Choose a reason for hiding this comment

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

LGTM, thanks 👍

@mschristensen mschristensen merged commit 268c098 into integration/liveobjects Apr 2, 2025
5 checks passed
@mschristensen mschristensen deleted the feature/PUB-1049-pubsub-docs-liveobjects branch April 2, 2025 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@VeskeR VeskeR VeskeR approved these changes

@m-hulbert m-hulbert m-hulbert approved these changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mschristensen @VeskeR @m-hulbert