Vue: Cleanup comments in Vue templates

[jonniebigodes]

With this pull request, the Vue CLI example stories were updated to remove an unnecessary comment regarding render functions. We're not using them in our examples, and this messaging leads to a misconception.

What I did

• Cleaned up the Vue templates by removing the render-specific comments to avoid confusion.

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

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

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
  • Removed documentation comments from Storybook story files.

[nx-cloud]

View your CI Pipeline Execution ↗ for commit e99696e

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

---

☁️ Nx Cloud last updated this comment at 2025-11-17 20:24:23 UTC

[github-actions]

	Fails
🚫	PR is not labeled with one of: ["cleanup","BREAKING CHANGE","feature request","bug","documentation","maintenance","build","dependencies"]

Generated by 🚫 dangerJS against e99696e

[coderabbitai]

📝 Walkthrough

Walkthrough

Removed documentation comment blocks describing render functions from two Vue 3 Storybook Button story template files. No functional changes or modifications to story exports.

Changes

Cohort / File(s)	Summary
Comment removal in Vue 3 Button stories code/frameworks/vue3-vite/template/cli/ts/Button.stories.ts, code/renderers/vue3/template/cli/ts/Button.stories.ts	Removed documentation comment blocks describing render functions in Storybook CSF. Story exports (Primary, Secondary, Large, Small) and control flow remain unchanged.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

✨ Finishing touches

• 📝 Generate docstrings

---

📜 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 3c27f14 and e3df3ad.

📒 Files selected for processing (2)

• code/frameworks/vue3-vite/template/cli/ts/Button.stories.ts (1 hunks)
• code/renderers/vue3/template/cli/ts/Button.stories.ts (1 hunks)

🧰 Additional context used

🧠 Learnings (3)

📓 Common learnings

Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32458
File: code/core/src/components/components/Tabs/Tabs.stories.tsx:222-227
Timestamp: 2025-11-05T09:36:55.944Z
Learning: Repo: storybookjs/storybook PR: 32458 — In code/core/src/components/components/Button/Button.tsx (React/TypeScript), ButtonProps includes ariaLabel?: string | false and the component maps it to the DOM aria-label. Convention: ariaLabel is mandatory on all Button usages — provide a descriptive string for icon-only buttons; set ariaLabel=false when the button’s children already serve as the accessible name. Do not suggest using a raw aria-label prop on Button call sites.

📚 Learning: 2025-11-05T09:36:55.944Z

Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32458
File: code/core/src/components/components/Tabs/Tabs.stories.tsx:222-227
Timestamp: 2025-11-05T09:36:55.944Z
Learning: Repo: storybookjs/storybook PR: 32458 — In code/core/src/components/components/Button/Button.tsx (React/TypeScript), ButtonProps includes ariaLabel?: string | false and the component maps it to the DOM aria-label. Convention: ariaLabel is mandatory on all Button usages — provide a descriptive string for icon-only buttons; set ariaLabel=false when the button’s children already serve as the accessible name. Do not suggest using a raw aria-label prop on Button call sites.

Applied to files:

• code/frameworks/vue3-vite/template/cli/ts/Button.stories.ts
• code/renderers/vue3/template/cli/ts/Button.stories.ts

📚 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:

• code/frameworks/vue3-vite/template/cli/ts/Button.stories.ts
• code/renderers/vue3/template/cli/ts/Button.stories.ts

⏰ 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). (2)

• GitHub Check: normal
• GitHub Check: Core Unit Tests, windows-latest

🔇 Additional comments (2)

code/renderers/vue3/template/cli/ts/Button.stories.ts (1)

26-26: LGTM! Cleanup improves template clarity.

The removal of the render function comment is appropriate since these Vue 3 story templates use object-based story definitions (CSF3 format) rather than render functions. This cleanup prevents confusion for developers using these templates.

code/frameworks/vue3-vite/template/cli/ts/Button.stories.ts (1)

26-26: LGTM! Consistent cleanup across Vue 3 templates.

The removal of the render function comment matches the cleanup in the vue3 renderer template, maintaining consistency across both Vue 3 template variants. This improves accuracy for users scaffolding new Storybook projects.

---

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