316e37eb7b
- 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
1.5 KiB
| title |
|---|
| Documentation updates |
Fix a typo or clarify a section of the docs. This page outlines how to edit the documentation.
Find the Markdown file
Scroll to the bottom of the document in question, then click ✍️ Edit on GitHub – PRs welcome! This will open the Markdown file on GitHub.
Use GitHub's web editor by clicking the pencil icon on the right-hand corner. Tweak the document to your liking.
Scroll down to the bottom of the document page on GitHub and describe what you changed and why. Select the Create a new branch for this commit and start a pull request option then click the Propose changes button.
Create the pull request
In the Storybook repository, create a pull request that describes changes and includes additional context that would help maintainers review. Once you submit the PR, a maintainer will guide you through the triage and merge process.
Other ways to contribute
Learn about other ways you can contribute to Storybook.
- Overview: General guidance
- Code: Features, bug fixes, dependency updates
- Addons: Build an addon and share it with the community
- Frameworks: Integrate Storybook with your favorite library