Skip to content

Docs: Fix Eslint outdated URLs#33304

Merged
jonniebigodes merged 2 commits into
nextfrom
sidnioulz/fix-docs-404-eslint-plugin
Dec 9, 2025
Merged

Docs: Fix Eslint outdated URLs#33304
jonniebigodes merged 2 commits into
nextfrom
sidnioulz/fix-docs-404-eslint-plugin

Conversation

@Sidnioulz
Copy link
Copy Markdown
Member

@Sidnioulz Sidnioulz commented Dec 8, 2025

Closes this Discord thread

What I did

Replaced the link, duh :)

Checklist for Contributors

Testing

ø

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 publish.yml --field pr=<PR_NUMBER>

Summary by CodeRabbit

  • Documentation
    • Updated ESLint plugin documentation link to reference the Storybook repository directly.
    • Fixed a grammar error in the ESLint plugin documentation page.

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

@Sidnioulz Sidnioulz added documentation ci:docs Run the CI jobs for documentation checks only. labels Dec 8, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Dec 8, 2025

📝 Walkthrough

Walkthrough

Updated the ESLint plugin documentation link from an external repository URL to an internal Storybook repository path, and corrected the article "an dedicated" to "a dedicated".

Changes

Cohort / File(s) Change Summary
Documentation link and grammar fix
docs/configure/integration/eslint-plugin.mdx
Updated ESLint plugin documentation link reference and corrected article grammar

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9548e92 and 531e3a8.

📒 Files selected for processing (1)
  • docs/configure/integration/eslint-plugin.mdx (1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📚 Learning: 2025-09-24T13:04:58.631Z
Learnt from: cylewaitforit
Repo: storybookjs/storybook PR: 31965
File: code/lib/eslint-plugin/src/rules/only-csf3.ts:31-33
Timestamp: 2025-09-24T13:04:58.631Z
Learning: The Storybook ESLint plugin supports ESLint v8.57+ where context.sourceCode is already available as a property since it was introduced in v8.40.0, so no fallback to context.getSourceCode() is needed in rules.

Applied to files:

  • docs/configure/integration/eslint-plugin.mdx
📚 Learning: 2025-11-28T14:50:24.889Z
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.889Z
Learning: Follow existing patterns and conventions in the Storybook codebase

Applied to files:

  • docs/configure/integration/eslint-plugin.mdx
📚 Learning: 2025-11-05T09:38:47.712Z
Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32458
File: code/core/src/components/components/Select/Select.tsx:200-204
Timestamp: 2025-11-05T09:38:47.712Z
Learning: Repo: storybookjs/storybook — Guidance: Until Storybook 11 is released, do not suggest using React.useId anywhere (e.g., in code/core/src/components/components/Select/Select.tsx) to maintain compatibility with React 17 runtimes. Prefer advising: accept a caller-provided props.id and, if needed, generate a client-only fallback id to minimize SSR hydration issues — but avoid useId. Resume prompting for useId after Storybook 11.

Applied to files:

  • docs/configure/integration/eslint-plugin.mdx
⏰ 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). (1)
  • GitHub Check: Core Unit Tests, windows-latest
🔇 Additional comments (1)
docs/configure/integration/eslint-plugin.mdx (1)

9-9: Approved: Grammar fix and URL consolidation.

The change corrects the grammar error ("an dedicated" → "a dedicated") and consolidates the ESLint plugin link from an external repository to the internal Storybook monorepo path. This aligns with the PR objective to fix the outdated 404 link and maintains consistency with the rule documentation links in the table below.

Please verify that the new internal path (https://github.com/storybookjs/storybook/tree/next/code/lib/eslint-plugin) is accessible and correctly resolves the 404 issue mentioned in the Discord thread.


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

@jonniebigodes jonniebigodes added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Dec 9, 2025
Copy link
Copy Markdown
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@Sidnioulz, thanks for updating the documentation. Appreciate it 🙏 !
Everything is good on my end, and I will merge this once the checklist is cleared.

Have a great day

Stay safe

@jonniebigodes jonniebigodes changed the title Docs: Fix outdated URL Docs: Fix Eslint outdated URLs Dec 9, 2025
@jonniebigodes jonniebigodes merged commit bf657ee into next Dec 9, 2025
20 checks passed
@jonniebigodes jonniebigodes deleted the sidnioulz/fix-docs-404-eslint-plugin branch December 9, 2025 12:07
valentinpalkovic pushed a commit that referenced this pull request Dec 10, 2025
…int-plugin

Docs: Fix Eslint outdated URLs
(cherry picked from commit bf657ee)
@github-actions github-actions Bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Dec 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs Run the CI jobs for documentation checks only. documentation patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants