Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Consistently adopt recommended meta pattern #29263

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

bmulholland
Copy link

@bmulholland bmulholland commented Oct 2, 2024

Updating docs with suggestion from #21221 (comment)

(If this is no longer the suggestion, then a direct export of meta would be cleaner instead. Like this: #21221 (comment))

Greptile Summary

This PR updates the TypeScript type definitions in code snippets for Storybook stories, improving type inference and aligning with recommended meta patterns.

  • Changed Story type definition to use typeof meta instead of direct component type in /docs/_snippets/typed-csf-file.md
  • Updated code snippets for Angular, common (TypeScript 4.9+), common (TypeScript), and Web Components renderers
  • Maintained consistency across different renderer examples while applying the new type definition approach
  • Aligned documentation with the suggestion from the related issue (Bug: Type support for Vue component slots in stories #21221) discussion

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

@shilman shilman added documentation csf ci:docs Run the CI jobs for documentation checks only. labels Oct 7, 2024
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. csf documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants