docs: Update README - Githubissues

open-sauced / intro

Empowering Your Open Source Journey: From First Contribution to Project Leadership

https://opensauced.pizza/learn

Other

497 stars 96 forks source link

docs: Update README #94

Closed adiati98 closed 7 months ago

adiati98 commented 8 months ago

Description

This PR holds changes to update README as follow:

Added the Types of contributions chapter to the Course Overview section.
Fixed wordings in text links.
Fixed broken links.
Added links.
Fixed and adjusted wordings — also in 06-the-secret-sauce.md.

Live Preview

https://deploy-preview-94--sauced-intro.netlify.app/#/

What type of PR is this? (check all applicable)

[ ] 🍕 Feature
[x] 🐛 Bug Fix
[x] 📝 Documentation Update
[ ] 🎨 Style
[ ] 🧑‍💻 Code Refactor
[ ] 🔥 Performance Improvements
[ ] ✅ Test
[ ] 🤖 Build
[ ] 🔁 CI
[ ] 📦 Chore (Release)
[ ] ⏩ Revert

Related Tickets & Documents

Closes #93

Mobile & Desktop Screenshots/Recordings

Added tests?

[ ] 👍 yes
[x] 🙅 no, because they aren't needed
[ ] 🙋 no, because I need help

Added to documentation?

[x] 📜 README.md
[ ] 📓 docs.opensauced.pizza
[ ] 🍕 dev.to/opensauced
[ ] 📕 storybook
[ ] 🙅 no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

netlify[bot] commented 8 months ago

Deploy Preview for sauced-intro ready!

Name	Link
Latest commit	cd75a6fade1871bbdb3699ebeb1bc67a16b5bcbc
Latest deploy log	https://app.netlify.com/sites/sauced-intro/deploys/655252c990195b0008733940
Deploy Preview	https://deploy-preview-94--sauced-intro.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

BekahHW commented 7 months ago

Great job, @adiati98!