Skip to content

Conversation

@JatinMehta007
Copy link
Contributor

@JatinMehta007 JatinMehta007 commented Oct 7, 2025

Closes #32662

What I did

his PR fixes the broken documentation link for "Learn how to add tags" in the Tags dropdown menu (TagsFilterPanel).

The anchor tag for the documentation has changed in the Storybook documentation from #filtering-by-custom-tags to #custom-tags.

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

Note for Reviewer: I was unable to run the project locally due to setup/build errors, so I could not perform manual verification.

Steps to test (for Reviewer):

  1. Run Storybook.
  2. Open the Tags dropdown menu in the sidebar.
  3. Hover over the "Learn how to add tags" link.
  4. VERIFY that the final link URL includes both the correct anchor and the version number (e.g., https://storybook.js.org/docs/10/writing-stories/tags#custom-tags).

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.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Summary by CodeRabbit

  • Documentation

    • Updated the “Learn how to add tags” help link in the Tags filter panel to point to the correct documentation page.
  • Style

    • Refined light theme syntax colors, updating red and cyan hues to improve readability and visual consistency.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 7, 2025

Caution

Review failed

The head commit changed during the review from 988ea6d to feb2808.

📝 Walkthrough

Walkthrough

Updated a docs link in TagsFilterPanel’s development-only menu and adjusted two light theme syntax color literals in theming. No changes to exports, logic, or control flow.

Changes

Cohort / File(s) Summary of Changes
UI: Tags filter docs link
code/core/src/manager/components/sidebar/TagsFilterPanel.tsx
Updated docs URL from writing-stories/tags#filtering-by-custom-tags to writing-stories/tags#custom-tags.
Theming: Light syntax color tweaks
code/core/src/theming/convert.ts
Changed lightSyntaxColors.red4 from #ff0000 to #D24400, and lightSyntaxColors.cyan2 from #2B91AF to #24659F.

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

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

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 331177b and 7d1679f.

📒 Files selected for processing (2)
  • code/core/src/manager/components/sidebar/TagsFilterPanel.tsx (1 hunks)
  • code/core/src/theming/convert.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Adhere to ESLint and Prettier rules across all JS/TS source files

Files:

  • code/core/src/theming/convert.ts
  • code/core/src/manager/components/sidebar/TagsFilterPanel.tsx
**/*.{ts,tsx}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Fix type errors and prefer precise typings instead of using any or suppressions, consistent with strict mode

Files:

  • code/core/src/theming/convert.ts
  • code/core/src/manager/components/sidebar/TagsFilterPanel.tsx
🔇 Additional comments (1)
code/core/src/theming/convert.ts (1)

15-15: Clarify undocumented color changes in convert.ts
Confirm whether the updates to red4 (#D24400) and cyan2 (#24659F) in code/core/src/theming/convert.ts (lines 15, 18) are intentional enhancements or unintended edits that should be reverted.

Comment on lines 15 to 18
red4: '#D24400',
gray1: '#393A34',
cyan1: '#36acaa',
cyan2: '#2B91AF',
cyan2: '#24659F',
Copy link
Member

Choose a reason for hiding this comment

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

Why were these colors changed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @yannbf, that's a great question!

You are seeing the color changes because they were merged into my feature branch from a separate, earlier PR that focused on style.

The changes themselves were made to refine the red and cyan syntax colors in the light theme to improve contrast and overall readability for our users, as mentioned in the summary.

This PR's main purpose is just the documentation link fix in the TagsFilterPanel.tsx file (the 7d1679f commit). Sorry for the confusion!

@nx-cloud
Copy link

nx-cloud bot commented Oct 13, 2025

View your CI Pipeline Execution ↗ for commit 4e4c61b

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 47s View ↗

☁️ Nx Cloud last updated this comment at 2025-10-14 17:07:56 UTC

@jonniebigodes
Copy link
Contributor

Merging this as it's technically a bug and before we forget about it and have to patch it back. It's best to get it in as soon as possible

@jonniebigodes jonniebigodes merged commit 15bdc1d into storybookjs:next Oct 14, 2025
53 checks passed
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.

[Bug]: SB10 - Broken link in the Tags dropdown menu

4 participants