Add documentation for client deactivation

[hackerwins]

What this PR does / why we need it?

Add documentation for client deactivation

Any background context you want to provide?

What are the relevant tickets?

Fixes #

Checklist

• Added relevant tests or not required
• Didn't break anything

Summary by CodeRabbit

• Documentation
  • Updated the Yorkie JS SDK documentation with a new section on deactivating the client.
  • Added guidance on resource release and server disconnection.
  • Included a code example for implementing the deactivation process, especially for the beforeunload event.
  • Mentioned the keepalive option for maintaining client activity during page closure.

[coderabbitai]

Walkthrough

The documentation for the Yorkie JS SDK has been updated to include a new subsection titled "Deactivate the Client." This section outlines the method client.deactivate(), detailing the process for properly releasing resources and disconnecting from the server. It emphasizes the importance of detaching documents for efficient garbage collection and includes a code example for implementation, particularly in relation to the beforeunload event. Additionally, the documentation mentions the keepalive option in the deactivate request.

Changes

File	Change Summary
docs/js-sdk.mdx	Added a new subsection "Deactivate the Client" detailing the client.deactivate() method, its usage, and a code example. Mentioned the keepalive option in the deactivation request.

Poem

In the meadow where bunnies play,
A new guide has come our way.
To deactivate and set things right,
We clean up well, oh what a sight!
With client.deactivate(), we cheer,
For tidy code, we hold so dear! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
  • 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 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.

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (3)

docs/js-sdk.mdx (3)

48-51: Enhance the introduction with specific details about resources.

Consider expanding the introduction to specify the types of resources that get released (e.g., network connections, memory, event listeners) to help developers better understand the importance of proper cleanup.

 When the client is no longer needed, you can deactivate it to release resources and disconnect from the server.
+When the client is no longer needed, you can deactivate it to release resources (such as network connections, memory allocations, and event listeners) and disconnect from the server.

---

52-54: Add error handling to the deactivation example.

Consider adding error handling to demonstrate proper cleanup even when deactivation fails.

-await client.deactivate();
+try {
+  await client.deactivate();
+} catch (error) {
+  console.error('Failed to deactivate client:', error);
+  // Handle cleanup failure
+}

---

56-56: Enhance the garbage collection explanation.

Consider adding a brief explanation of what garbage collection does in this context, before linking to the detailed design document.

-This will detach all documents attached to the client for efficient [garbage collection](https://github.com/yorkie-team/yorkie/blob/main/design/garbage-collection.md).
+This will detach all documents attached to the client, allowing the system to clean up unused resources and CRDT tombstones through [garbage collection](https://github.com/yorkie-team/yorkie/blob/main/design/garbage-collection.md).

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d957a40 and 73e7104.

📒 Files selected for processing (1)

• docs/js-sdk.mdx (1 hunks)