Skip to content

Commit 812acde

Browse files
authored
docs: fix some sentences in the "Welcome to the Community" and "Introduction to Storybook" section for clarity and fix some typos. (open-sauced#130)
* Update welcome-to-the-community.md Added more context and fixed the unordered list inconsistent spacing * Update introduction-to-contributing.md Revised and clarified the "Testing" section, and provided additional details in the "Building" section. * doc: Improved the Storybook doc by fixing typos, rephrased sentences to be clear and fixed heading inconsistencies Worked on this issue. The "Introduction to Storybook" doc needs improvement open-sauced#133
1 parent 032f9b8 commit 812acde

File tree

3 files changed

+15
-16
lines changed

3 files changed

+15
-16
lines changed

docs/community/welcome-to-the-community.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,8 @@ At OpenSauced, we strive to create a welcoming and inclusive community for every
2424
The OpenSauced community is a group of open-source enthusiasts who are passionate about making open-source more accessible to everyone. Here are some ways you can keep up with what we're doing:
2525

2626
- 🐦 Follow us on Twitter [@SaucedOpen](https://twitter.com/saucedopen) for announcements and our frequent Twitter Spaces.
27-
2827
- Join our [Discord](https://discord.gg/opensauced), and hang out with us in our weekly office hours.
29-
3028
- Subscribe to our [YouTube channel](https://www.youtube.com/@OpenSauced) for the latest updates and video content for OpenSauced.
31-
3229
- 📰 Subscribe to our [newsletter](https://news.opensauced.pizza/#/portal/signup) for all things OpenSauced and open source.
3330

3431
## How can I get involved?
@@ -40,6 +37,7 @@ You can get involved in the OpenSauced community in a few ways:
4037
- Share what you're working on, ask questions, or mentor new contributors in our [Discord](https://discord.gg/opensauced).
4138

4239
## Resources on Getting Started with Open Source
40+
Getting started with open source can be quite daunting for beginners, so we've put together some resources to help you get started.
4341

4442
- 📝 Check out our [Dev blog](https://dev.to/opensauced) where we provide resources for open-source contributors.
4543
- 📖 Take our [Intro to Open Source Course](https://github.com/open-sauced/intro) to help you get started with open-source.

docs/contributing/introduction-to-contributing.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,20 @@ npm ci
3434
```
3535

3636
## Building
37+
To generate a production-ready version of your code, run:
3738

3839
```shell
3940
npm run build
4041
```
4142

4243
## Testing
4344

44-
For running the test suite, use the following command. Since the tests run in watch mode by default, some users may encounter errors about too many files being open. In this case, it may be beneficial to [install watchman](https://facebook.github.io/watchman/docs/install.html).
45-
45+
For running the test suite, use the following command:
4646
```shell
4747
# the tests will run in watch mode by default
4848
npm test
4949
```
50+
Since the tests run in watch mode by default, some users may encounter errors about too many files being open. In this case, it may be beneficial to [install watchman](https://facebook.github.io/watchman/docs/install.html).
5051

5152
For more info on testing React and JavaScript, check out this course [Testing JavaScript](https://testingjavascript.com/)
5253

docs/technical/introduction-to-storybook.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: Introduction to storybook
55
keywords:
66
- Introduction to storybook
77
---
8-
8+
Storybook is an open-source tool that helps developers build, test, and document UI components in isolation.
99
Storybook is being leveraged to mock out visual React components. The latest version of the design system can be found at this [URL](https://sauced-components.netlify.app/).
1010

1111
To run storybook, use this command:
@@ -20,34 +20,34 @@ Storybook is broken into several categories:
2020

2121
<ul>
2222
<li><b>Button:</b> These are the button elements that appear in the project in various forms. They primarily are the Button component in the project but can also be icons.</li>
23-
<li><b>Cards:</b> These are the main container elements in the project. Each item represents a live component in their current form in the project.</li>
23+
<li><b>Cards:</b> These are the main container elements in the project. Each item represents a live component in its current form in the project.</li>
2424
<li><b>Primitives: These are the basic styling of base HTML components.</b></li>
25-
<li><b>Nav:</b> This is the main navigation bar for the project. There are two states, when there is no user logged in and when a user is logged in.</li>
25+
<li><b>Nav:</b> This is the main navigation bar for the project. There are two stateswhen there is no user logged in and when a user is logged in.</li>
2626
<li><b>Footer:</b> This represents the various footers for the project.</li>
27-
<li><b>Homepage:</b> This is the main component for the project homepage and shows the home page in its current form.</li>
27+
<li><b>Homepage:</b> This is the main component of the project homepage and shows the home page in its current form.</li>
2828
<li><b>Miscellaneous:</b> These are components that currently don't fit neatly into the above categories.</li>
2929
</ul>
3030

3131
## Making changes to storybook
3232

33-
This section details how to make changes to Storybook, mainly creating new categories or UI elements.
34-
35-
## Adding a new category
33+
This section details how to make changes to Storybook, mainly by creating new categories or UI elements.
3634

37-
To add a new category, a new file needs to be added to `/stories`. Please follow the naming convention of `*Previous File Number + 1*-*Name of Story Capitalized*-stories.js` when creating a new file. In the file ensure you have this code in the file:
35+
### Adding a new category
3836

37+
To add a new category, a new file needs to be added to the `/stories` directory. When creating a new file, the filename should be named using the following convention: ```*Previous File Number + 1*-*Name of Story Capitalized*-stories.js```. For example, if the last file was 2-SideBar-stories.js, then the new file should be named ```3-NameOfYourFile-stories.js```.
38+
In the file ensure you have this code:
3939
```
4040
export default {
4141
title: "*Name of category*"
4242
};
4343
```
4444

45-
## Adding a new UI element
45+
### Adding a new UI element
4646

47-
To add a new UI element to to an existing category, add the following code to that category's file:
47+
To add a new UI element to an existing category, add the following code to that category's file:
4848

4949
```
5050
export const *Name of UI Element* = () => (
51-
51+
// code for the new element
5252
);
5353
```

0 commit comments

Comments
 (0)