Skip to content

Conversation

@ndianabasi
Copy link

@ndianabasi ndianabasi commented Jan 9, 2026

Description

This PR improves the README for the Drag-N-Drop example to highlight and highlights that Internal Drag and Drop is demonstrated within the example.

Fixes # (issue)

Type of change

Please select the option that is relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration using wails doctor.

  • Windows
  • macOS
  • Linux

If you checked Linux, please specify the distro and version.

Test Configuration

Please paste the output of wails doctor. If you are unable to run this command, please describe your environment in as much detail as possible.

Checklist:

  • I have updated website/src/pages/changelog.mdx with details of this PR
  • My code follows the general coding style of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • Documentation
    • Replaced "See also" with an "HTML5 Drag and Drop API" section in the example README
    • Added explanatory text describing the in-app drag-and-drop demo and guidance to scroll to the "Internal Drag and Drop" section to interact with it
    • Noted the README update in the changelog

✏️ Tip: You can customize this high-level summary in your review settings.

Added details about internal drag and drop functionality.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 9, 2026

Walkthrough

Documentation updates: README for the drag-n-drop example was revised to replace the "See also" section with an "HTML5 Drag and Drop API" section and add instructions to scroll to the "Internal Drag and Drop" demo; UNRELEASED_CHANGELOG.md was updated to reference the README change.

Changes

Cohort / File(s) Summary
Example README
v3/examples/drag-n-drop/README.md
Replaced "See also" with "HTML5 Drag and Drop API"; added explanatory text about the demo and a note to scroll to the "Internal Drag and Drop" section to interact with it.
Changelog
v3/UNRELEASED_CHANGELOG.md
Replaced placeholder comment with an entry noting the README update for the Drag N Drop example and the highlighted "Internal Drag and Drop" demonstration.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • leaanthony

Poem

🐰 A README hopped in, tidy and light,
It points to drag, to drop, and to sight,
“Scroll down,” it whispers, “the demo’s inside,”
Small docs, big joy — let curiosity glide ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description check ❓ Inconclusive The description covers the core change (updating README to highlight Internal Drag and Drop) and correctly identifies it as a documentation update. However, it is missing required sections: no issue reference in 'Fixes #', no testing details, and no wails doctor output despite being a non-trivial change. Add an issue reference in 'Fixes #' section, provide testing details (even if minimal), and include wails doctor output or environment description to complete the template.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: enhancing the README for the Drag-N-Drop example to include information about Internal Drag and Drop.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Jan 9, 2026

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In @v3/UNRELEASED_CHANGELOG.md:
- Line 22: Fix the grammatical mismatch in the UNRELEASED_CHANGELOG.md entry for
the "Drag N Drop" example by changing "and highlights that `Internal Drag and
Drop` is demonstrated with the example" to a parallel form such as "and
highlight that `Internal Drag and Drop` is demonstrated with the example"; also
append a PR reference for traceability (e.g., "PR #<number>") next to the GitHub
handle @ndianabasi so the line becomes something like: Update the README for the
`Drag N Drop` example and highlight that `Internal Drag and Drop` is
demonstrated with the example — @ndianabasi (PR #<number>).
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1c6fd03 and 451826a.

📒 Files selected for processing (1)
  • v3/UNRELEASED_CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: Run Go Tests v3 (macos-latest, 1.24)
  • GitHub Check: Run Go Tests v3 (windows-latest, 1.24)
  • GitHub Check: Run Go Tests v3 (ubuntu-latest, 1.24)
  • GitHub Check: semgrep-cloud-platform/scan


## Changed
<!-- Changes in existing functionality -->
- Update the README for the `Drag N Drop` example and highlights that `Internal Drag and Drop` is demonstrated with the example @ndianabasi
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix grammar and add PR reference for consistency.

The entry has a grammatical error with mismatched parallel structure ("and highlights" should be "and highlight" or restructured). Additionally, per the example entries in the guidelines (lines 40–50), PR references should be included for traceability.

✏️ Proposed fix
-- Update the README for the `Drag N Drop` example and highlights that `Internal Drag and Drop` is demonstrated with the example @ndianabasi
+- Update the README for the `Drag N Drop` example to highlight that `Internal Drag and Drop` is demonstrated with the example (#4869)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- Update the README for the `Drag N Drop` example and highlights that `Internal Drag and Drop` is demonstrated with the example @ndianabasi
- Update the README for the `Drag N Drop` example to highlight that `Internal Drag and Drop` is demonstrated with the example (#4869)
🤖 Prompt for AI Agents
In @v3/UNRELEASED_CHANGELOG.md at line 22, Fix the grammatical mismatch in the
UNRELEASED_CHANGELOG.md entry for the "Drag N Drop" example by changing "and
highlights that `Internal Drag and Drop` is demonstrated with the example" to a
parallel form such as "and highlight that `Internal Drag and Drop` is
demonstrated with the example"; also append a PR reference for traceability
(e.g., "PR #<number>") next to the GitHub handle @ndianabasi so the line becomes
something like: Update the README for the `Drag N Drop` example and highlight
that `Internal Drag and Drop` is demonstrated with the example — @ndianabasi (PR
#<number>).

@leaanthony leaanthony merged commit 897479d into wailsapp:v3-alpha Jan 10, 2026
66 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants