storybook/docs/contribute/documentation-updates.md
2021-05-26 20:51:03 -04:00

24 lines
1.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
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.
![Storybook documentation edit](./storybook-edit-docs-optimized.png)
Use GitHub's web editor by clicking the pencil icon on the right-hand corner. Tweak the document to your liking.
![GitHub edit documentation](./github-docs-edit-optimized.png)
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.
![Fill the commit information](./storybook-docs-submit-changes-optimized.png)
## 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.