Skip to content

Docs: Fixes for change detection#34732

Merged
kylegach merged 4 commits into
nextfrom
docs-change-detection-fixes
May 8, 2026
Merged

Docs: Fixes for change detection#34732
kylegach merged 4 commits into
nextfrom
docs-change-detection-fixes

Conversation

@kylegach
Copy link
Copy Markdown
Contributor

@kylegach kylegach commented May 6, 2026

What I did

  • Replace images
  • Structure and prose improvements

Checklist for Contributors

Testing

Manual testing

N/A - docs-only change

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

Summary by CodeRabbit

  • Documentation
    • Updated Change Detection docs to match new UI wording and behavior (Review button now “announces” new/modified stories)
    • Added a status indicators table defining new, modified, and related states and priority rules
    • Documented Review button placement, one-click toggling of new+modified filters, and updated active-state screenshot
    • Shortened Filtering section and added callout explaining filters are off by default

- Replace images
- Structure and prose improvements
@kylegach kylegach self-assigned this May 6, 2026
@kylegach kylegach requested a review from jonniebigodes as a code owner May 6, 2026 21:53
@kylegach kylegach added documentation ci:docs Run the CI jobs for documentation checks only. labels May 6, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 6, 2026

Review Change Stack
No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9715feed-4614-4235-b577-028869d53cae

📥 Commits

Reviewing files that changed from the base of the PR and between e8fff02 and 62dac13.

📒 Files selected for processing (1)
  • docs/configure/user-interface/change-detection.mdx
✅ Files skipped from review due to trivial changes (1)
  • docs/configure/user-interface/change-detection.mdx

📝 Walkthrough

Walkthrough

Update change-detection docs: reword the Review button to “announce” new/modified stories, replace the status legend with a new table (new, modified, related), add a Reviewing changes section and active-state screenshot, add a callout about default filters, and shorten the Filtering copy.

Changes

Change Detection UI Documentation

Layer / File(s) Summary
Intro & imagery
docs/configure/user-interface/change-detection.mdx
Intro paragraph updated to say Review announces new and modified stories; sidebar image/caption replaced to match new wording.
Status indicators table
docs/configure/user-interface/change-detection.mdx
Old icon dictionary replaced with a table defining new, modified, and related statuses; priority rule (new > modified > related) retained.
Review button behavior
docs/configure/user-interface/change-detection.mdx
New "Reviewing changes" section added describing Review button placement and that one click toggles both new and modified filters; active-state image updated.
Callout: default filters
docs/configure/user-interface/change-detection.mdx
Callout inserted explaining why modified and related filters are off by default due to heuristic imperfections.
Filtering copy & visuals
docs/configure/user-interface/change-detection.mdx
Filtering section copy shortened and now directs users to the filter menu for granular per-status selection; images/captions updated as needed.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs


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

Copy link
Copy Markdown
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

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/configure/user-interface/change-detection.mdx`:
- Line 10: Update the image alt text in the Markdown line that currently reads
"Sidebar showing review button and new storya status icons" to correct the typo
by replacing "storya" with "story" so it reads "Sidebar showing review button
and new story status icons"; locate the image markdown containing that alt
string and edit only the alt text.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3a22fb7d-bdc6-4837-912f-7d7a4c4d62f1

📥 Commits

Reviewing files that changed from the base of the PR and between e4ac3cc and 7527438.

⛔ Files ignored due to path filters (4)
  • docs/_assets/configure/change-detection-dual-slot.png is excluded by !**/*.png
  • docs/_assets/configure/change-detection-filter-menu.png is excluded by !**/*.png
  • docs/_assets/configure/change-detection-full.png is excluded by !**/*.png
  • docs/_assets/configure/change-detection-review-button-active.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • docs/configure/user-interface/change-detection.mdx

Comment thread docs/configure/user-interface/change-detection.mdx Outdated
Comment thread docs/configure/user-interface/change-detection.mdx Outdated
Copy link
Copy Markdown
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: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/configure/user-interface/change-detection.mdx`:
- Around line 41-51: The doc currently says the Review button "toggles both the
new and modified filters together" but the Callout only states that "modified
and related filters are off by default", leaving the default state of the new
filter ambiguous; update the text to explicitly state the default states (e.g.,
"By default new stories are shown; modified and related are off") either by
extending the existing Callout (the Callout block with variant="info" icon="💡")
or by adding a single clarifying sentence in the "Reviewing changes" paragraph
around the Review button description so readers know whether the new filter is
on or off by default.
- Around line 27-31: The "related" status row in the change-detection table is
missing an Icon entry; either add the actual icon glyph used by the sidebar for
the "related" status or explicitly indicate there is no icon (e.g., put a dash
"—" in the Icon column and a short parenthetical like "no distinct icon") so the
"related" row is consistent with the "new" and "modified" rows and readers won't
be left guessing; update the table row for the "related" status accordingly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: acb1813d-f1ac-41b8-8a88-25b2fec16ad7

📥 Commits

Reviewing files that changed from the base of the PR and between 7527438 and e8fff02.

📒 Files selected for processing (1)
  • docs/configure/user-interface/change-detection.mdx

Comment thread docs/configure/user-interface/change-detection.mdx Outdated
Comment thread docs/configure/user-interface/change-detection.mdx
kylegach added 2 commits May 8, 2026 12:44
* next: (49 commits)
  Remove mention of `ai setup` command
  Address feedback
  Cli: set ai prompt to yes if yes flag for react-vite to tanstack migration
  Update React Native entry point tests to use dynamic app name and include LiteUI component
  Add '@storybook/react-native-ui-lite' to React Native generator and template
  Update code/lib/create-storybook/templates/react-native/index.js
  Update AppRegistry component name in React Native template
  Remove extensive prompt option and related references from ai setup
  Fix: keep original onAllStatusChange timing behavior
  Update tests
  Remove duplicate index/refs update in onAllStatusChange handler
  Address CodeRabbit review feedback
  fix(manager-api): await recompute filter calls to refresh story list
  Ensure runId for ai-setup events is always at the root
  docs: add link
  chore: move tinyclip to devdeps
  Rework run deduplication logic for final telemetry
  Tanstack: optimize react-store
  Docs tweaks
  feat: always log the prompt
  ...
@kylegach kylegach merged commit 0874b09 into next May 8, 2026
15 checks passed
@kylegach kylegach deleted the docs-change-detection-fixes branch May 8, 2026 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

agent-scan:human ci:docs Run the CI jobs for documentation checks only. documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants