Skip to content

EDU-2000: Adds vcdiff to JS delta docs#2703

Merged
franrob-projects merged 3 commits into
mainfrom
EDU-2000-Updates-delta-docs
Jul 18, 2025
Merged

EDU-2000: Adds vcdiff to JS delta docs#2703
franrob-projects merged 3 commits into
mainfrom
EDU-2000-Updates-delta-docs

Conversation

@franrob-projects
Copy link
Copy Markdown
Contributor

@franrob-projects franrob-projects commented Jul 7, 2025

This PR:

https://ably.atlassian.net/browse/EDU-2000

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jul 7, 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.
    • 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.

@franrob-projects franrob-projects added the review-app Create a Heroku review app label Jul 7, 2025
@m-hulbert m-hulbert temporarily deployed to ably-docs-edu-2000-upda-aifbkp July 8, 2025 10:07 Inactive
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-2000-upda-aifbkp July 8, 2025 12:50 Inactive
@franrob-projects franrob-projects force-pushed the EDU-2000-Updates-delta-docs branch from c451dd6 to 9de02cc Compare July 8, 2025 12:51
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-2000-upda-aifbkp July 8, 2025 12:52 Inactive
@franrob-projects franrob-projects marked this pull request as ready for review July 8, 2025 12:52
Comment thread content/channels/options/deltas.textile Outdated
});
```

blang[javascript,nodejs].
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.

I'd maybe just put this under the original blang above rather than separating out.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

See 40c0260

Comment thread content/channels/options/deltas.textile Outdated

h2(#vcdiff). Install vcdiff decoder

A Vcdiff decoder written in pure JavaScript. The vcdiff decoder is a JavaScript library that decodes delta-compressed messages, allowing clients to reconstruct full messages from the small "diffs" sent by Ably to reduce bandwidth usage.
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.

I think we can make this a lot shorter since the context of what it does is already on the page.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

See 40c0260

@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-2000-upda-aifbkp July 9, 2025 16:50 Inactive
@franrob-projects franrob-projects merged commit c994360 into main Jul 18, 2025
6 checks passed
@franrob-projects franrob-projects deleted the EDU-2000-Updates-delta-docs branch July 18, 2025 09:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review-app Create a Heroku review app

Development

Successfully merging this pull request may close these issues.

3 participants