Add explanation for Filtering Presence Changes in Documentation

[gwbaik9717]

Updated the documentation to provide instructions on how to filter out presence changes.

What this PR does / why we need it?

Since presence event filter has been added to devtools, the document needs to be updated accordingly.

Any background context you want to provide?

What are the relevant tickets?

Fixes #151

Checklist

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

Summary by CodeRabbit

• New Features
  • Introduced filtering options in the Yorkie 🐾 panel's History section, allowing users to focus on document modifications.
  • Added a toggle feature to easily switch between viewing all changes and filtered changes.

[CLAassistant]

All committers have signed the CLA.

[coderabbitai]

Walkthrough

The recent update to the Yorkie 🐾 panel's History section introduces a new filter feature, enhancing user interaction by enabling the filtering out of presence changes. Users can click the Y button to focus on significant document modifications, improving the usability of the history feature. This toggle functionality allows users to effortlessly switch back to viewing all changes, providing a streamlined experience for analyzing document history.

Changes

File	Change Summary
docs/devtools.mdx	Added documentation for the new filtering feature in the History section.

Assessment against linked issues

Objective	Addressed	Explanation
Update DevTools Documentation to include new Filter...	✅

🐰 In the land of code, a toggle delight,
Presence fades away, revealing what's right!
With a click of Y, the changes unfold,
A history so clear, a story retold.
Hops of joy in this dev space we roam,
For Yorkie's new features, we call it home! 🐾

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a5bee53 and c01c6f1.

Files selected for processing (1)

• docs/devtools.mdx (1 hunks)

Additional comments not posted (1)

docs/devtools.mdx (1)

75-76: LGTM! Clear and concise instructions.

The new instructions for the filter feature in the History panel are clear and accurately describe the functionality of the Y button to filter out presence changes.

[hackerwins]

@gwbaik9717 Please sign the CLA.

[gwbaik9717]

I've done it! Thank you for letting me know.

[hackerwins]

Thanks for your contribution.