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

Add contribute/framework doc #19943

Merged
merged 3 commits into from
Nov 29, 2022
Merged

Add contribute/framework doc #19943

merged 3 commits into from
Nov 29, 2022

Conversation

kylegach
Copy link
Contributor

What I did

Add a page at the /docs/<framework>/contribute/framework route explaining how to contribute a Storybook framework

Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

This is great!

Historically, people have wanted to contribute frameworks directly to the monorepo--I wonder if this doc should somehow preempt that.

I also wonder about a step on distributing the framework, e.g. tweet and mention @storybookjs. Or if the pattern described here will automatically get picked up by the integrations catalog, mention that?

Copy link
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.

@kylegach, this looks great. Just left a couple of items for you to look at. Let me know if you're ok with it, and we'll go from there also while we're at it. It seems that you left out the toc.js entry so we can hook this up to the documentation. Was this intentional or not?

docs/contribute/framework.md Outdated Show resolved Hide resolved
docs/contribute/framework.md Outdated Show resolved Hide resolved
- Add bits about announcing and path to "official" status
- Add link to TOC
- Change 'Write the README' heading to 'Write the documentation"
- Remove 'Thank you' section
- Add 'Other ways to contribute' section
    - Update/add corresponding section on other relevant pages
@kylegach kylegach force-pushed the contribute-framework-doc branch from 98ebd68 to 316e37e Compare November 28, 2022 17:55
Copy link
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.

Thanks for taking care of the feedback so promptly @kylegach! Appreciate it. All good on my end! Merge when able

@kylegach kylegach merged commit 9b5532e into next Nov 29, 2022
@kylegach kylegach deleted the contribute-framework-doc branch November 29, 2022 15:58
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.

4 participants