docs: fix some sentences in the "Welcome to the Community" and "Introduction to Storybook" section for clarity and fix some typos. #130
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added more context and fixed the unordered list inconsistent spacing
Update welcome-to-the-community.md
Revised and clarified the "Testing" section, and provided additional details in the "Building" section.
✅ Deploy Preview for docs-open ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Compliance Checks
Thank you for your Pull Request! We have run several checks on this pull request in order to make sure it's suitable for merging into this project. The results are listed in the following section.
Issue Reference
In order to be considered for merging, the pull request description must refer to a specific issue number. This is described in our Contributing Guide.
This check is looking for a phrase similar to: "Fixes #XYZ" or "Resolves #XYZ" where XYZ is the issue number that this PR is meant to address.
Protected Branch
In order to be considered for merging, the pull request changes must not be implemented on the "main" branch. This is described in our Contributing Guide. We would suggest that you close this PR and implement your changes as described in our Contributing Guide and open a new pull request.
bdougie
changed the title
|
@Barry-dE thanks for your contribution. Could you add context and clarity on these changes. Our projects leverage the PR body for the changelog, but you did not fill out the template. |
Barry-dE
changed the title
… to be clear and fixed heading inconsistencies Worked on this issue. The "Introduction to Storybook" doc needs improvement open-sauced#133
Fixed issue open-sauced#133: The "Introduction to Storybook" doc needs improvement
CBID2
reviewed
Aug 14, 2023
Barry-dE
commented
Aug 15, 2023
Thank you for your feedback. I have added more context on the changes I made. Please review and let me know if anything isn't clear. |
Barry-dE
changed the title
Barry-dE
changed the title
Barry-dE
changed the title
Barry-dE
changed the title
bdougie
approved these changes
Aug 21, 2023
|
🎉 This PR is included in version 1.39.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
github-actions bot
pushed a commit
that referenced
this pull request
Aug 21, 2023
…duction to Storybook" section for clarity and fix some typos. (#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 #133 812acde
github-actions bot
pushed a commit
to Lymah123/docs
that referenced
this pull request
Mar 30, 2024
## 1.0.0 (2024-03-30) ### Features * 100 days of oss ([open-sauced#99](https://github.com/Lymah123/docs/issues/99)) ([cc922e4](cc922e4)) * Add a Contributors guide ([open-sauced#229](https://github.com/Lymah123/docs/issues/229)) ([ec79f59](ec79f59)) * add algolia search functionality to docs ([open-sauced#196](https://github.com/Lymah123/docs/issues/196)) ([4a2dd05](4a2dd05)) * add better open sauced asset branding ([open-sauced#46](https://github.com/Lymah123/docs/issues/46)) ([2902366](2902366)), closes [open-sauced#32](https://github.com/Lymah123/docs/issues/32) * add chrome extension intro and usage to docs ([open-sauced#78](https://github.com/Lymah123/docs/issues/78)) ([3597a93](3597a93)) * Add Community docs ([open-sauced#96](https://github.com/Lymah123/docs/issues/96)) ([1efb238](1efb238)) * add Connections feature page ([open-sauced#191](https://github.com/Lymah123/docs/issues/191)) ([d887897](d887897)) * add explainer page about PR velocity ([open-sauced#151](https://github.com/Lymah123/docs/issues/151)) ([619574f](619574f)) * Add FAQ section to Contributing Guide ([open-sauced#103](https://github.com/Lymah123/docs/issues/103)) ([b534680](b534680)) * Add gifs showing extension ([open-sauced#89](https://github.com/Lymah123/docs/issues/89)) ([006bef8](006bef8)) * add link to public calendar ([open-sauced#218](https://github.com/Lymah123/docs/issues/218)) ([e8a0da5](e8a0da5)) * Add lists to docs ([open-sauced#193](https://github.com/Lymah123/docs/issues/193)) ([ceb5af5](ceb5af5)) * add maintainer docs ([open-sauced#12](https://github.com/Lymah123/docs/issues/12)) ([d215c75](d215c75)), closes [open-sauced#5](https://github.com/Lymah123/docs/issues/5) * Add maintainers guide section ([open-sauced#205](https://github.com/Lymah123/docs/issues/205)) ([d5ba31e](d5ba31e)) * Add maintainers-guide ([open-sauced#177](https://github.com/Lymah123/docs/issues/177)) ([e4e2dab](e4e2dab)) * add missing contributing docs ([open-sauced#20](https://github.com/Lymah123/docs/issues/20)) ([a4465e6](a4465e6)), closes [open-sauced#11](https://github.com/Lymah123/docs/issues/11) * add more descriptions for using the chrome extension page ([open-sauced#116](https://github.com/Lymah123/docs/issues/116)) ([442ae78](442ae78)) * add release workflow ([open-sauced#1](https://github.com/Lymah123/docs/issues/1)) ([c1635a4](c1635a4)) * Add student guide ([open-sauced#283](https://github.com/Lymah123/docs/issues/283)) ([eb591fd](eb591fd)) * add users docs about highlights ([open-sauced#100](https://github.com/Lymah123/docs/issues/100)) ([17dd7fd](17dd7fd)) * Add workspaces documentation ([open-sauced#255](https://github.com/Lymah123/docs/issues/255)) ([103fda2](103fda2)) * Added new Favicon ([open-sauced#75](https://github.com/Lymah123/docs/issues/75)) ([ad351ca](ad351ca)), closes [open-sauced#65](https://github.com/Lymah123/docs/issues/65) * adding job seekers guide ([open-sauced#221](https://github.com/Lymah123/docs/issues/221)) ([8f8f1d5](8f8f1d5)) * adding page about hacktoberfest ([open-sauced#179](https://github.com/Lymah123/docs/issues/179)) ([d9cedb7](d9cedb7)) * Adding subfolders to the using section for Chrome Extension ([open-sauced#123](https://github.com/Lymah123/docs/issues/123)) ([a785c55](a785c55)) * adds glossary ([open-sauced#212](https://github.com/Lymah123/docs/issues/212)) ([70f7925](70f7925)) * Adds image and instructions on how to get DevCard page ([open-sauced#234](https://github.com/Lymah123/docs/issues/234)) ([b358c27](b358c27)) * Adds info on adding teammates to the insights page ([open-sauced#230](https://github.com/Lymah123/docs/issues/230)) ([d6b4681](d6b4681)) * adds new favicons ([open-sauced#58](https://github.com/Lymah123/docs/issues/58)) ([3bec3fe](3bec3fe)), closes [open-sauced#47](https://github.com/Lymah123/docs/issues/47) * creating separate section for setting up repo with Git ([open-sauced#192](https://github.com/Lymah123/docs/issues/192)) ([d68a086](d68a086)) * expanded on `npm run push` ([open-sauced#76](https://github.com/Lymah123/docs/issues/76)) ([499b5a4](499b5a4)), closes [open-sauced#39](https://github.com/Lymah123/docs/issues/39) * explore plugin ecosystem ([open-sauced#22](https://github.com/Lymah123/docs/issues/22)) ([8e14b13](8e14b13)), closes [open-sauced#8](https://github.com/Lymah123/docs/issues/8) * implement @open-sauced/check-engines ([open-sauced#14](https://github.com/Lymah123/docs/issues/14)) ([2a787ff](2a787ff)) * implement @open-sauced/conventional commit ([open-sauced#28](https://github.com/Lymah123/docs/issues/28)) ([b79ddee](b79ddee)), closes [open-sauced#25](https://github.com/Lymah123/docs/issues/25) * push initial commit ([16304a7](16304a7)) * re-add algolia search ([open-sauced#9](https://github.com/Lymah123/docs/issues/9)) ([0d8baae](0d8baae)), closes [open-sauced#2](https://github.com/Lymah123/docs/issues/2) * rearranges sections for easy consumption ([open-sauced#118](https://github.com/Lymah123/docs/issues/118)) ([257a44c](257a44c)) * removes outdated open-sauced docs ([open-sauced#86](https://github.com/Lymah123/docs/issues/86)) ([8a31879](8a31879)) * Reorganize docs ([open-sauced#201](https://github.com/Lymah123/docs/issues/201)) ([dc12081](dc12081)) * replace intro image and link ([open-sauced#73](https://github.com/Lymah123/docs/issues/73)) ([b7b1e30](b7b1e30)) * terminology added ([open-sauced#184](https://github.com/Lymah123/docs/issues/184)) ([c3fcfc8](c3fcfc8)) * Update API docs to v2 ([open-sauced#239](https://github.com/Lymah123/docs/issues/239)) ([de93e7a](de93e7a)) * update docs to be more specific and reflect current features ([open-sauced#155](https://github.com/Lymah123/docs/issues/155)) ([45abbf7](45abbf7)) * Update logo in header nav to new logo ([open-sauced#55](https://github.com/Lymah123/docs/issues/55)) ([1c75731](1c75731)) * Update logo.svg Feature: Update Favicon to Pizza [open-sauced#80](https://github.com/Lymah123/docs/issues/80) ([open-sauced#82](https://github.com/Lymah123/docs/issues/82)) ([dc406ef](dc406ef)) * update project documentation with SEO keywords ([open-sauced#237](https://github.com/Lymah123/docs/issues/237)) ([664cc7f](664cc7f)) * Update sidebar with new sections ([open-sauced#217](https://github.com/Lymah123/docs/issues/217)) ([20f4dfe](20f4dfe)) * update workspace with more information on team plan ([open-sauced#272](https://github.com/Lymah123/docs/issues/272)) ([2a82913](2a82913)) ### Bug Fixes * add missing config minor ([open-sauced#19](https://github.com/Lymah123/docs/issues/19)) ([8fb7a03](8fb7a03)) * add missing spaces in faq ([open-sauced#115](https://github.com/Lymah123/docs/issues/115)) ([b2dc854](b2dc854)) * add parallel structure ([open-sauced#175](https://github.com/Lymah123/docs/issues/175)) ([c50e6ba](c50e6ba)) * add private repo note ([65172a8](65172a8)) * build error ([open-sauced#240](https://github.com/Lymah123/docs/issues/240)) ([6f602a5](6f602a5)) * Change title and sidebar ([open-sauced#187](https://github.com/Lymah123/docs/issues/187)) ([ceb3d0f](ceb3d0f)) * correct ci development flow ([0434010](0434010)) * correct docker deploy variables ([open-sauced#17](https://github.com/Lymah123/docs/issues/17)) ([db0b965](db0b965)) * correct node 17 webpack security concerns and audit fix ([22d2ea5](22d2ea5)) * correct npm install in docker container ([open-sauced#23](https://github.com/Lymah123/docs/issues/23)) ([7d08e18](7d08e18)) * Correct typo in resolve-merge-conflicts.md ([open-sauced#128](https://github.com/Lymah123/docs/issues/128)) ([72f3b45](72f3b45)) * Documentation Link Misdirection ([open-sauced#148](https://github.com/Lymah123/docs/issues/148)) ([180b032](180b032)) * failed build from "OpenSauced Maintainers Guides" ([open-sauced#247](https://github.com/Lymah123/docs/issues/247)) ([bec1ab7](bec1ab7)) * fix broken links ([open-sauced#141](https://github.com/Lymah123/docs/issues/141)) ([81f27b9](81f27b9)) * format and wording adjustments in workspaces, contributors and repo insights sections ([open-sauced#262](https://github.com/Lymah123/docs/issues/262)) ([37bddac](37bddac)) * highlights.md sidebar link ([9b03f41](9b03f41)) * improve intro to contributing ([open-sauced#63](https://github.com/Lymah123/docs/issues/63)) ([356b6ee](356b6ee)) * Incorrect Link Destination in Documentation ([open-sauced#144](https://github.com/Lymah123/docs/issues/144)) ([c7adf37](c7adf37)) * Issues Section ([open-sauced#269](https://github.com/Lymah123/docs/issues/269)) ([785e75a](785e75a)) * items array in OpenSauced Maintainers Guides sidebar ([open-sauced#245](https://github.com/Lymah123/docs/issues/245)) ([aa0f249](aa0f249)) * logo swap between light mode and dark mode ([open-sauced#57](https://github.com/Lymah123/docs/issues/57)) ([ad3af5d](ad3af5d)) * re-add footer logo ([972edfc](972edfc)) * remove storybook id from sidebar file ([open-sauced#231](https://github.com/Lymah123/docs/issues/231)) ([f14b184](f14b184)) * Renamed open sauced to OpenSauced ([open-sauced#90](https://github.com/Lymah123/docs/issues/90)) ([adc093c](adc093c)) * Revert "docs: add Community Maintainers Guidelines" ([open-sauced#244](https://github.com/Lymah123/docs/issues/244)) ([21c3fcf](21c3fcf)), closes [open-sauced#243](https://github.com/Lymah123/docs/issues/243) * Revert "fix: items array in OpenSauced Maintainers Guides sidebar" ([open-sauced#246](https://github.com/Lymah123/docs/issues/246)) ([bd9dfd1](bd9dfd1)), closes [open-sauced#245](https://github.com/Lymah123/docs/issues/245) * revise markdown errors ([open-sauced#107](https://github.com/Lymah123/docs/issues/107)) ([637d735](637d735)) * simplified the merge conflicts section ([open-sauced#232](https://github.com/Lymah123/docs/issues/232)) ([6ce00fa](6ce00fa)) * text to be more concise [open-sauced#160](https://github.com/Lymah123/docs/issues/160) ([open-sauced#161](https://github.com/Lymah123/docs/issues/161)) ([18993ab](18993ab)) * the gif ([open-sauced#149](https://github.com/Lymah123/docs/issues/149)) ([c4d8a1e](c4d8a1e)) * triage.yml ([open-sauced#67](https://github.com/Lymah123/docs/issues/67)) ([b23cbf0](b23cbf0)) * update dead contributing link in readme ([open-sauced#15](https://github.com/Lymah123/docs/issues/15)) ([dd11c65](dd11c65)), closes [open-sauced#13](https://github.com/Lymah123/docs/issues/13) * Update docs for 100 days of oss ([open-sauced#271](https://github.com/Lymah123/docs/issues/271)) ([0a7f9aa](0a7f9aa)) * Update Highlights page to fix broken path and provide more information. ([open-sauced#164](https://github.com/Lymah123/docs/issues/164)) ([e0aab72](e0aab72)) * Update license language in contributing guide ([open-sauced#152](https://github.com/Lymah123/docs/issues/152)) ([49539e8](49539e8)) * update node and npm versions ([open-sauced#180](https://github.com/Lymah123/docs/issues/180)) ([f35a4c7](f35a4c7)) * Update project-utilities.md browser-extensions mention to ai ([open-sauced#88](https://github.com/Lymah123/docs/issues/88)) ([4ab5656](4ab5656)) * update workspace images based on latest UI ([open-sauced#277](https://github.com/Lymah123/docs/issues/277)) ([12c8ffd](12c8ffd)) * update youtube link on docs ([open-sauced#121](https://github.com/Lymah123/docs/issues/121)) ([7e3b8bd](7e3b8bd)) * updated link to PR Velocity ([open-sauced#220](https://github.com/Lymah123/docs/issues/220)) ([fb5adec](fb5adec)) * workaround license check by adding license ([open-sauced#35](https://github.com/Lymah123/docs/issues/35)) ([f0abac6](f0abac6)) * workflow.yml ([open-sauced#162](https://github.com/Lymah123/docs/issues/162)) ([05cb60f](05cb60f)) ### Code Refactoring * update minor deps and clean up ([7dcbe97](7dcbe97)) ### Build System * add dependabot missing minors ([open-sauced#16](https://github.com/Lymah123/docs/issues/16)) ([338a418](338a418)) ### Continuous Integration * add docusaurus-prince-pdf generation ([open-sauced#24](https://github.com/Lymah123/docs/issues/24)) ([8d4bacf](8d4bacf)) * add open-sauced triage wonkflows ([open-sauced#10](https://github.com/Lymah123/docs/issues/10)) ([dfb508a](dfb508a)) * correct docker deploy variables ([open-sauced#18](https://github.com/Lymah123/docs/issues/18)) ([71caaa1](71caaa1)) * correct dockerfile build for ghcr ([804ed80](804ed80)) ### Documentation * add authentication section ([open-sauced#62](https://github.com/Lymah123/docs/issues/62)) ([26f8511](26f8511)) * add Community Maintainers Guidelines ([open-sauced#243](https://github.com/Lymah123/docs/issues/243)) ([67f3118](67f3118)) * Add events ([open-sauced#119](https://github.com/Lymah123/docs/issues/119)) ([577efe1](577efe1)) * add head metadata ([open-sauced#59](https://github.com/Lymah123/docs/issues/59)) ([df4b7e0](df4b7e0)), closes [open-sauced#45](https://github.com/Lymah123/docs/issues/45) * Add information about PR with unassigned issue to the contributing guidelines ([open-sauced#252](https://github.com/Lymah123/docs/issues/252)) ([4ccd758](4ccd758)), closes [open-sauced#251](https://github.com/Lymah123/docs/issues/251) [open-sauced#251](https://github.com/Lymah123/docs/issues/251) * add lint section to intro to contributing ([open-sauced#66](https://github.com/Lymah123/docs/issues/66)) ([b427242](b427242)) * add release docs for open-sauced/conventional-commit ([open-sauced#27](https://github.com/Lymah123/docs/issues/27)) ([0937830](0937830)), closes [open-sauced#26](https://github.com/Lymah123/docs/issues/26) [open-sauced#30](https://github.com/Lymah123/docs/issues/30) [open-sauced#31](https://github.com/Lymah123/docs/issues/31) * Add section on workspaces to maintainers guide ([open-sauced#279](https://github.com/Lymah123/docs/issues/279)) ([c0fe6b9](c0fe6b9)) * Add Team Sync instructions to FAQs ([open-sauced#207](https://github.com/Lymah123/docs/issues/207)) ([eb940a1](eb940a1)) * Added extension-utilities-docs ([open-sauced#83](https://github.com/Lymah123/docs/issues/83)) ([148c0ee](148c0ee)) * Added PR review menu docs ([open-sauced#98](https://github.com/Lymah123/docs/issues/98)) ([a88e3a9](a88e3a9)) * adding a gif of doing a highlight on the website ([open-sauced#137](https://github.com/Lymah123/docs/issues/137)) ([0a9d371](0a9d371)) * adding an explainer page and GIF on insight pages ([open-sauced#138](https://github.com/Lymah123/docs/issues/138)) ([b957398](b957398)) * adding explainer page about Dev card ([open-sauced#158](https://github.com/Lymah123/docs/issues/158)) ([4d48443](4d48443)) * adding section for the Hot OpenSauced Project ([open-sauced#197](https://github.com/Lymah123/docs/issues/197)) ([4555cb8](4555cb8)) * Adding Testing JavaScript link ([open-sauced#40](https://github.com/Lymah123/docs/issues/40)) ([3055bcb](3055bcb)), closes [open-sauced#37](https://github.com/Lymah123/docs/issues/37) * apply markdown formatting magic ([fa7ed0e](fa7ed0e)) * correct contributing link ([open-sauced#34](https://github.com/Lymah123/docs/issues/34)) ([5664e61](5664e61)), closes [open-sauced#33](https://github.com/Lymah123/docs/issues/33) * fix some sentences in the "Welcome to the Community" and "Introduction to Storybook" section for clarity and fix some typos. ([open-sauced#130](https://github.com/Lymah123/docs/issues/130)) ([812acde](812acde)), closes [open-sauced#133](https://github.com/Lymah123/docs/issues/133) * Project utilities hijack ([open-sauced#117](https://github.com/Lymah123/docs/issues/117)) ([794b54f](794b54f)) * Provide Docs Feedback & Fix Markdown and Metadata for Consistency ([open-sauced#213](https://github.com/Lymah123/docs/issues/213)) ([7264c3e](7264c3e)) * Reorganize Subsections in the Intro to Contributing ([open-sauced#233](https://github.com/Lymah123/docs/issues/233)) ([935e09a](935e09a)) * replace url for finding good first issue ([open-sauced#153](https://github.com/Lymah123/docs/issues/153)) ([d006a6c](d006a6c)) * revise information about templates ([open-sauced#135](https://github.com/Lymah123/docs/issues/135)) ([321e8c9](321e8c9)) * Typo fix in the Contribution docs ([open-sauced#41](https://github.com/Lymah123/docs/issues/41)) ([56db201](56db201)), closes [open-sauced#42](https://github.com/Lymah123/docs/issues/42) * Update 100-days-of-oss.md ([open-sauced#109](https://github.com/Lymah123/docs/issues/109)) ([c57387d](c57387d)) * update github docs and static docker build ([02ffdd7](02ffdd7)) * Updates docs to add mentions of `beta` ([open-sauced#44](https://github.com/Lymah123/docs/issues/44)) ([97c699c](97c699c))
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request addresses issue #133 and more.
This pull request includes distinct changes to two parts of the doc:
What type of PR is this? (check all applicable)
Related Tickets & Documents
Mobile & Desktop Screenshots/Recordings
Added tests?
Added to documentation?
[optional] Are there any post-deployment tasks we need to perform?
[optional] What gif best describes this PR or how it makes you feel?
The PR makes me feel really good about myself.