DAT-511: Data Clips Documentation

[meganspaulding]

DAT-511

[coderabbitai]

Walkthrough

This pull request introduces a new guide for the beta "DataClips" feature and updates the events documentation. The guide details how DataClips allow users to extract, edit, and collaborate on subsets of data without modifying the original dataset. It covers the processes for creating, editing, and merging DataClips. Additionally, three new events—data-clip:created, data-clip:updated, and data-clip:deleted—are documented in the events section, including their context and payload structures, along with minor typographical corrections.

Changes

File(s)	Change Summary
guides/dataclips.mdx	New guide detailing the beta DataClips feature. Explains creating DataClips, editing records, collaboration, merging with a diff interface, and managing clips via a library.
orchestration/events.mdx	Added a new "DataClips" section documenting three events (data-clip:created, data-clip:updated, data-clip:deleted) with descriptions and JSON examples.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI as "DataClip UI"
    participant Backend as "Application Backend"
    participant EventSys as "Event System"

    User->>UI: Initiate DataClip creation
    UI->>Backend: Request creation with selected records
    Backend->>EventSys: Trigger data-clip:created event
    EventSys-->>Backend: Acknowledge event logging
    Backend-->>UI: Return created DataClip details

    alt DataClip Update
        User->>UI: Modify DataClip details
        UI->>Backend: Submit update request
        Backend->>EventSys: Trigger data-clip:updated event
        EventSys-->>Backend: Acknowledge event logging
        Backend-->>UI: Confirm update
    end

    alt DataClip Deletion
        User->>UI: Request deletion of DataClip
        UI->>Backend: Send deletion command
        Backend->>EventSys: Trigger data-clip:deleted event
        EventSys-->>Backend: Acknowledge event logging
        Backend-->>UI: Confirm deletion
    end

Loading

Warning

Review ran into problems

🔥 Problems

GitHub Actions and Pipeline Checks: Resource not accessible by integration - https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository.

Please grant the required permissions to the CodeRabbit GitHub App under the organization or repository settings.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 45d427c and 2247742.

📒 Files selected for processing (2)

• guides/dataclips.mdx (1 hunks)
• orchestration/events.mdx (1 hunks)

---

Note

🎁 Summarized by CodeRabbit Free

Your organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.If you believe this is a mistake and have available seats, please assign one to the pull request author through the subscription management page using the link above.

🪧 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. (Beta)
• @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.