[jpan-box]

Overview

These README files were the styleguidist pages that rendered each icon group. Styleguidist and the IconsExample wrapper are gone, and Storybook has no page to link instead: it only has an ItemIcon story and a collections story, and it does not catalog the general, file, folder, badges, avatars, annotations, illustrations, placeholders, states, two-toned, box-tools, or metadata-view icons. Deleting the files leaves the icon components in place.

• Blast radius: the old icon catalog pages.
• Risk: someone still opens those README files as the icon list. The components remain in src/icons.

What

• The icon components stay. The styleguidist catalog pages go away.
• There is no Storybook story to link in their place.

Why

• Styleguidist was the only reader of these README files, and that tool is gone.
• The pages call IconsExample, and that wrapper was deleted with examples/.
• Storybook does not have an equivalent catalog for these icon groups.

How

• Delete the pages rather than point them at opensource.box.com, because that site does not show these catalogs.
• Start at src/icons.

Detail, verification, and deferred work

The pre-push hook succeeded. It compiled the ES build, built the locale bundles, and ran Jest for files changed since upstream/master. Jest found no tests related to the deleted pages.

The DraggableList story link stays for a separate pull request.

Summary by CodeRabbit

• Documentation
  • Removed icon documentation pages covering annotations, avatars, badges, collections, file and folder icons, illustrations, and other icon categories. Examples and usage guidance previously available in those pages are no longer included.

[coderabbitai]

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

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: 42b15d29-b795-4235-935a-f176e5235e6d

Commits

Reviewing files that changed from the base of the PR and between 09b773c and 6138f34.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• Trigger review

No actionable comments were generated in the recent review.

Walkthrough

This change deletes README documentation for icon categories under src/icons. The removed content included icon usage examples, component galleries, prop details, and styling guidance.

Changes

Icon documentation

Layer / File(s)	Summary
Remove icon catalog documentation src/icons/*/README.md	Deletes icon category documentation, including usage examples, icon lists, prop details, and styling guidance.

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

Change: Other

Possibly related PRs

• box/box-ui-elements#4941: Updates a documentation link to a Storybook story as part of cleanup after the old examples and Styleguidist documentation were removed.

Suggested reviewers: tjuanitas, jcamden, pjzabinski

Merge Risk: Minimal · previous review 09b77

No actionable merge-blocking risk is established for the icon documentation removal.

Pre-merge checks: 5

Check name	Status	Explanation
Title check		The title "docs(icons): remove styleguidist catalog readmes" matches the main change. The PR deletes the Styleguidist README pages that catalogued icon groups under src/icons, and the icon components …
Description check		The description follows the repository template's intent. The template is a merge-process checklist about the ready-to-merge label, approvals, and reviewers, and the author's description does not repe…
Docstring Coverage		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		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Title check

Explanation

The title "docs(icons): remove styleguidist catalog readmes" matches the main change. The PR deletes the Styleguidist README pages that catalogued icon groups under src/icons, and the icon components stay in place. The title is specific, short, and uses a conventional commit style.

Full details: Description check

Explanation

The description follows the repository template's intent. The template is a merge-process checklist about the ready-to-merge label, approvals, and reviewers, and the author's description does not repeat it. The author instead gives a clear Overview, What, Why, and How, plus a collapsed section for verification and deferred work. It explains the scope, the risk, and why no Storybook replacement exists. It states that the pre-push hook passed and that the DraggableList story link is deferred. The template's merge-process guidance is not addressed, so a reviewer may still need to follow the ready-to-merge steps separately.

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.

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

• X
• Mastodon
• Reddit
• LinkedIn

_{A rabbit finds the pages gone,
The icon guides have hopped along.
No gallery remains to view,
No usage snippets to review.
The README burrow rests anew.}

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: bcf0ff96-c670-4c6f-9f58-049c4bea4365

Commits

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

Files selected for processing: 13

• src/icons/annotations/README.md
• src/icons/avatars/README.md
• src/icons/badges/README.md
• src/icons/box-tools/README.md
• src/icons/collections/README.md
• src/icons/file/README.md
• src/icons/folder/README.md
• src/icons/general/README.md
• src/icons/illustrations/README.md
• src/icons/metadata-view/README.md
• src/icons/placeholders/README.md
• src/icons/states/README.md
• src/icons/two-toned/README.md

Files with no reviewable changes: 13

• src/icons/badges/README.md
• src/icons/general/README.md
• src/icons/two-toned/README.md
• src/icons/file/README.md
• src/icons/placeholders/README.md
• src/icons/states/README.md
• src/icons/folder/README.md
• src/icons/annotations/README.md
• src/icons/collections/README.md
• src/icons/metadata-view/README.md
• src/icons/avatars/README.md
• src/icons/illustrations/README.md
• src/icons/box-tools/README.md

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

[mergify]

✅ Merged into master as 0454b0e at 18:16 UTC

14 min in the queue, 11 min of it CI.

So far

• ✅ Entered the queue Tue 3 Nov, 18:02 · rule Automatic strict merge · triggered by rule Automatic merge queue
• ✅ Passed · in place
• ✅ Merged 18:16 · 0454b0e · 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}