Docs: Clarify addon catalog indexing

[krish-mittal1]

Refs #35159

What I did

Updated the addon catalog timing section with a quick npm view check before opening an issue about a missing addon.

Checklist for Contributors

Testing

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

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

Manual testing

Caution

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Read docs/addons/integration-catalog.mdx and check that the timing section tells addon authors what to verify before opening an issue.

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

• Declare whether manual QA will be needed for this PR during the next release, through qa:needed or qa:skip

• 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 the integration catalog troubleshooting guidance for addons not appearing.
  • Replaced outdated “24-hour” wording and issue-link instructions with a new flow: wait briefly, confirm required published metadata is present, and use npm view <package> --json to verify the latest catalog metadata.
  • Expanded “open an issue” details to include the addon’s npm package URL (latest version), repository link, and the npm view command output.

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR updates integration-catalog addon documentation to replace generic timing expectations with actionable troubleshooting steps. The changes instruct users to verify published metadata using npm commands and provide detailed diagnostic information when reporting catalog listing issues.

Changes

Addon Catalog Troubleshooting Guidance

Layer / File(s)	Summary
Troubleshooting flow and issue-reporting instructions docs/addons/integration-catalog.mdx	Replaced "How long does it take" timing guidance with a structured "If your addon doesn't appear" troubleshooting section that includes a verification step using npm view <package> --json to confirm published catalog metadata, instructions to check for required metadata, and expanded issue-reporting instructions requiring the npm package URL with version, repository link, and command output.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

---

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

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

[jonniebigodes]

@krish-mittal1 thanks for taking the time to put together this pull request and helping us improve the documentation. We appreciate it. I left some items for you to look into when you're able.

Let me know once you've gone through them and I'll gladly take another look into this pull request and get it merged.

Hope you have a great day.

Stay safe

[krish-mittal1]

Thanks for the review. I reverted the extra wording changes and kept this focused on the timing/troubleshooting section.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

docs/addons/integration-catalog.mdx (1)

94-96: 💤 Low value

Consider making the placeholder more explicit.

The placeholder your-addon-package-name could be clearer with angle brackets or other formatting to indicate it must be replaced.

📝 Suggested improvement

-npm view your-addon-package-name --json
+npm view <your-addon-package-name> --json

🤖 Prompt for 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.

In `@docs/addons/integration-catalog.mdx` around lines 94 - 96, The placeholder
text `your-addon-package-name` in the npm view shell command is not visually
distinct enough to clearly indicate it must be replaced. Wrap the placeholder
with angle brackets (change `your-addon-package-name` to
`<your-addon-package-name>`) to make it explicit that this is a placeholder
value that users need to substitute with their actual addon package name.

🤖 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/addons/integration-catalog.mdx`:
- Line 98: Update the GitHub repository link in the issue reporting instructions
to point to the correct repository for addon catalog issues. Change the link
from storybookjs/web (which is for the documentation website itself) to
storybookjs/storybook (where the addon catalog service is managed).
Additionally, consider enhancing the instructions by providing a concrete
example of the npm package URL format, such as
`https://www.npmjs.com/package/storybook-addon-example`, to clarify expectations
for users reporting catalog issues.

---

Nitpick comments:
In `@docs/addons/integration-catalog.mdx`:
- Around line 94-96: The placeholder text `your-addon-package-name` in the npm
view shell command is not visually distinct enough to clearly indicate it must
be replaced. Wrap the placeholder with angle brackets (change
`your-addon-package-name` to `<your-addon-package-name>`) to make it explicit
that this is a placeholder value that users need to substitute with their actual
addon package name.

🪄 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: e756db62-ab31-4463-bcc8-deb8365de62f

📥 Commits

Reviewing files that changed from the base of the PR and between fd4daf3 and 042abca.

📒 Files selected for processing (1)

• docs/addons/integration-catalog.mdx

[krish-mittal1]

Hi @jonniebigodes, I’ve addressed the review feedback and kept the PR focused on the timing/troubleshooting section. Could you take another look when you have time?

[jonniebigodes]

@krish-mittal1 thanks for addressing the feedback so promptly. I've checked and it all looks good on my end.

Will merge once the checklist clears.

Have a fantastic day
Stay safe