Skip to content

docs(draggable-list): point example link at the story - #4941

Merged
mergify[bot] merged 1 commit into
box:masterfrom
jpan-box:docs-draggable-list-example
Nov 3, 2026
Merged

mergify[bot] merged 1 commit into
box:masterfrom
jpan-box:docs-draggable-list-example

Conversation

@jpan-box

@jpan-box jpan-box commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Overview

The DraggableList story notes link to an example file that left the repo with the styleguide.

  • Blast radius: the notes shown on the DraggableList story.
  • Risk: a reader follows the new URL and finds the story file, which is where getItems lives now.

What

  • The notes link opens DraggableList.stories.tsx.

Why

  • The notes still send the reader to examples/src/DraggableListExamples.tsx.
  • That path was removed with the styleguide.

How

  • The story file kept the example, including getItems and DraggableListExamples.
  • Start at DraggableList.stories.md.
Detail, verification, and deferred work

The pre-push hook compiled the ES build, built locale bundles, and Jest found no tests related to this file.

The icon README snippets still require examples/src/IconsExample. Those catalogs are not part of this change.

Summary by CodeRabbit

  • Documentation
    • Updated the draggable-list example link to point to the current example reference. This is a documentation-only change; it does not alter app behavior or functionality. The revised link provides readers with an accurate path to the draggable-list example code.

@jpan-box
jpan-box requested a review from a team as a code owner November 3, 2026 16:26
@coderabbitai

coderabbitai Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Walkthrough

The draggable list story documentation now links to src/components/draggable-list/DraggableList.stories.tsx as its example code.

Changes

Story documentation link

Layer / File(s) Summary
Update story source link
src/components/draggable-list/DraggableList.stories.md
The example-code link now points to src/components/draggable-list/DraggableList.stories.tsx instead of examples/src/DraggableListExamples.tsx.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Suggested reviewers: sahiga

Merge Risk: Minimal · up to b8cd3

No merge-blocking risk was identified in this documentation-only update.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly and concisely states that the DraggableList documentation link now points to the story.
Description check Passed The description explains what changed, why it changed, the affected scope, risk, implementation details, and verification results. It is complete and relevant to the pull request.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

A rabbit checks the story page,
The link now points to the right stage.
One hop to the source file,
Then onward with a smile.
The burrow’s guide is clear today.

CodeRabbit Verify

  • Run CodeRabbit Verify to test the changes in this pull request.
Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: d28d6329-a108-49e6-b9c4-bf8b2bb1c73f
Commits

Reviewing files that changed from the base of the PR and between 48a60a4 and b8cd3ef.

Files selected for processing: 1
  • src/components/draggable-list/DraggableList.stories.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

@mergify mergify Bot added the queued label Nov 3, 2026
@mergify
mergify Bot merged commit 36791a6 into box:master Nov 3, 2026
10 of 11 checks passed
@mergify

mergify Bot commented Nov 3, 2026

Copy link
Copy Markdown
Contributor

✅ Merged into master as 36791a6 at 18:03 UTC

1 min in the queue, with no time running CI.

So far

  • ✅ Entered the queue Tue 3 Nov, 18:02 · rule Automatic strict merge · triggered by rule Automatic merge queue
  • ✅ Checks skipped · PR is already up-to-date
  • ✅ Merged 18:03 · 36791a6 · squash
5 merge conditions met
  • github-review-approved · required by GitHub branch protection
  • any of · required by GitHub branch protection:
    • check-success = Summary
    • check-neutral = Summary
    • check-skipped = Summary
  • any of · required by GitHub branch protection:
    • check-success = lint_test_build
    • check-neutral = lint_test_build
    • check-skipped = lint_test_build
  • any of · required by GitHub branch protection:
    • check-success = license/cla
    • check-neutral = license/cla
    • check-skipped = license/cla
  • any of · required by GitHub branch protection:
    • check-success = lint_pull_request
    • check-neutral = lint_pull_request
    • check-skipped = lint_pull_request

Times in UTC · dashboard · how the merge queue works

@mergify mergify Bot removed the queued label Nov 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants