From 3f59e47ea7228f6a014c84f8c0b585eb734b972c Mon Sep 17 00:00:00 2001 From: Barigbue Nbira Date: Wed, 9 Aug 2023 19:39:53 +0100 Subject: [PATCH 1/3] Update welcome-to-the-community.md Added more context and fixed the unordered list inconsistent spacing --- docs/community/welcome-to-the-community.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/community/welcome-to-the-community.md b/docs/community/welcome-to-the-community.md index 5ed9ff04..8f3f3a8b 100644 --- a/docs/community/welcome-to-the-community.md +++ b/docs/community/welcome-to-the-community.md @@ -24,11 +24,8 @@ At OpenSauced, we strive to create a welcoming and inclusive community for every 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: - 🐦 Follow us on Twitter [@SaucedOpen](https://twitter.com/saucedopen) for announcements and our frequent Twitter Spaces. - - Join our [Discord](https://discord.gg/opensauced), and hang out with us in our weekly office hours. - - Subscribe to our [YouTube channel](https://www.youtube.com/@OpenSauced) for the latest updates and video content for OpenSauced. - - 📰 Subscribe to our [newsletter](https://news.opensauced.pizza/#/portal/signup) for all things OpenSauced and open source. ## How can I get involved? @@ -40,6 +37,7 @@ You can get involved in the OpenSauced community in a few ways: - Share what you're working on, ask questions, or mentor new contributors in our [Discord](https://discord.gg/opensauced). ## Resources on Getting Started with Open Source +Getting started with open source can be quite daunting for beginners, so we've put together some resources to help you get started. - 📝 Check out our [Dev blog](https://dev.to/opensauced) where we provide resources for open-source contributors. - 📖 Take our [Intro to Open Source Course](https://github.com/open-sauced/intro) to help you get started with open-source. From 050651437396d8a8264f5a010e5006d8ff2106b2 Mon Sep 17 00:00:00 2001 From: Barigbue Nbira Date: Wed, 9 Aug 2023 21:55:41 +0100 Subject: [PATCH 2/3] Update introduction-to-contributing.md Revised and clarified the "Testing" section, and provided additional details in the "Building" section. --- docs/contributing/introduction-to-contributing.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/contributing/introduction-to-contributing.md b/docs/contributing/introduction-to-contributing.md index dfaa033c..41b6af40 100644 --- a/docs/contributing/introduction-to-contributing.md +++ b/docs/contributing/introduction-to-contributing.md @@ -34,6 +34,7 @@ npm ci ``` ## Building +To generate a production-ready version of your code, run: ```shell npm run build @@ -41,12 +42,12 @@ npm run build ## Testing -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). - +For running the test suite, use the following command: ```shell # the tests will run in watch mode by default npm test ``` +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). For more info on testing React and JavaScript, check out this course [Testing JavaScript](https://testingjavascript.com/) From 786437b061521e0cfa5026e49d6396de074b55d5 Mon Sep 17 00:00:00 2001 From: Barigbue Nbira Date: Sun, 13 Aug 2023 13:15:47 +0100 Subject: [PATCH 3/3] 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 #133 --- docs/technical/introduction-to-storybook.md | 22 ++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/technical/introduction-to-storybook.md b/docs/technical/introduction-to-storybook.md index f7c58f65..f9607517 100644 --- a/docs/technical/introduction-to-storybook.md +++ b/docs/technical/introduction-to-storybook.md @@ -5,7 +5,7 @@ sidebar_label: Introduction to storybook keywords: - Introduction to storybook --- - +Storybook is an open-source tool that helps developers build, test, and document UI components in isolation. 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/). To run storybook, use this command: @@ -20,34 +20,34 @@ Storybook is broken into several categories:
  • Button: 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.
    • -
  • Cards: These are the main container elements in the project. Each item represents a live component in their current form in the project.
    • +
  • Cards: These are the main container elements in the project. Each item represents a live component in its current form in the project.
  • Primitives: These are the basic styling of base HTML components.
    • -
  • Nav: 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.
    • +
  • Nav: 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.
  • Footer: This represents the various footers for the project.
    • -
  • Homepage: This is the main component for the project homepage and shows the home page in its current form.
    • +
  • Homepage: This is the main component of the project homepage and shows the home page in its current form.
  • Miscellaneous: These are components that currently don't fit neatly into the above categories.
## Making changes to storybook -This section details how to make changes to Storybook, mainly creating new categories or UI elements. - -## Adding a new category +This section details how to make changes to Storybook, mainly by creating new categories or UI elements. -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: +### Adding a new category +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```. +In the file ensure you have this code: ``` export default { title: "*Name of category*" }; ``` -## Adding a new UI element +### Adding a new UI element -To add a new UI element to to an existing category, add the following code to that category's file: +To add a new UI element to an existing category, add the following code to that category's file: ``` export const *Name of UI Element* = () => ( - +// code for the new element ); ```