Skip to content
This repository has been archived by the owner on Apr 29, 2024. It is now read-only.

feat: Add new chapter on practical application #35

Merged
merged 36 commits into from
Apr 3, 2024
Merged

Conversation

BekahHW
Copy link
Member

@BekahHW BekahHW commented Jan 19, 2024

Description

closes #31

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

  • πŸ• Feature
  • πŸ› Bug Fix
  • πŸ“ Documentation Update
  • 🎨 Style
  • πŸ§‘β€πŸ’» Code Refactor
  • πŸ”₯ Performance Improvements
  • βœ… Test
  • πŸ€– Build
  • πŸ” CI
  • πŸ“¦ Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

Steps to QA

Added to documentation?

  • πŸ“œ 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?

@BekahHW
Copy link
Member Author

BekahHW commented Jan 22, 2024

@adiati98 @jdwilkin4 I'm trying to decide if I should have the reader add to their Readme and add a contributing doc through VS Code or through the GH UI. Any thoughts?

@adiati98
Copy link
Member

@adiati98 @jdwilkin4 I'm trying to decide if I should have the reader add to their Readme and add a contributing doc through VS Code or through the GH UI. Any thoughts?

Do you mean you want the readers to create a new repo and prepare it for open sourcing?

If so, also because this will be used mostly by GH and its users, I'd say through GH UI is better. That way, they can experience including the README when they create the repo, and try out how to add a file directly from GH.

Including the Markdown Live Preview here to check the Markdown format would also be good.

@BekahHW BekahHW marked this pull request as ready for review February 19, 2024 22:35
Copy link
Member

@adiati98 adiati98 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BekahHW I'm adjusting some wording here, and would love to have your response about the comments so I can fix them too if necessary. Thank you! 😊

getting-practical.md Outdated Show resolved Hide resolved
getting-practical.md Outdated Show resolved Hide resolved
@BekahHW BekahHW requested a review from a team as a code owner March 11, 2024 18:38
@adiati98
Copy link
Member

adiati98 commented Mar 11, 2024

@BekahHW I've fixed some formats here and I'll look closely into this tomorrow.

A question: In the assets folder, we have gif, gifs, img, and images folders.
We might want to choose which ones to keep and later on, I can fix the paths altogether in #58.

Thanks!

@BekahHW
Copy link
Member Author

BekahHW commented Mar 14, 2024

@BekahHW I've fixed some formats here and I'll look closely into this tomorrow.

A question: In the assets folder, we have gif, gifs, img, and images folders. We might want to choose which ones to keep and later on, I can fix the paths altogether in #58.

Thanks!

We should be using the same structure as the intro course, bc those will ideally move over there in that repo.

Although. I just took a look at that and I'm not super excited about how it's organized. So do we change the structure now? Or just stick with how the intro repo has it where everything is in images?

@adiati98
Copy link
Member

@BekahHW I've fixed some formats here and I'll look closely into this tomorrow.
A question: In the assets folder, we have gif, gifs, img, and images folders. We might want to choose which ones to keep and later on, I can fix the paths altogether in #58.
Thanks!

We should be using the same structure as the intro course, bc those will ideally move over there in that repo.

Although. I just took a look at that and I'm not super excited about how it's organized. So do we change the structure now? Or just stick with how the intro repo has it where everything is in images?

If we want to change the structure, we better do it now. So, when we migrate to Astro or whatever we choose, we already have a structure. And it will be great if we already establish consistency.

  1. I'm thinking to have the assets structure as the docs.
.
└── assets/
    β”œβ”€β”€ images
    └── gif
  1. Looking at the intro course, I'm thinking to not having numbers as file name and chapter. Without numbers, it will be easier for us to maintain and if we need to move things around. The files there are something like 01-intro.md.

Copy link
Member

@adiati98 adiati98 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a couple of questions here. 😊

getting-practical.md Outdated Show resolved Hide resolved
getting-practical.md Outdated Show resolved Hide resolved
@BekahHW
Copy link
Member Author

BekahHW commented Mar 25, 2024

@BekahHW I've fixed some formats here and I'll look closely into this tomorrow.
A question: In the assets folder, we have gif, gifs, img, and images folders. We might want to choose which ones to keep and later on, I can fix the paths altogether in #58.
Thanks!

We should be using the same structure as the intro course, bc those will ideally move over there in that repo.
Although. I just took a look at that and I'm not super excited about how it's organized. So do we change the structure now? Or just stick with how the intro repo has it where everything is in images?

If we want to change the structure, we better do it now. So, when we migrate to Astro or whatever we choose, we already have a structure. And it will be great if we already establish consistency.

  1. I'm thinking to have the assets structure as the docs.
.
└── assets/
    β”œβ”€β”€ images
    └── gif
  1. Looking at the intro course, I'm thinking to not having numbers as file name and chapter. Without numbers, it will be easier for us to maintain and if we need to move things around. The files there are something like 01-intro.md.

This is what I think as well. And removing the numbers for sure.

@BekahHW BekahHW requested a review from adiati98 March 25, 2024 18:21
@adiati98
Copy link
Member

This is what I think as well. And removing the numbers for sure.

Do you want me to remove the numbers and adjust the instructions on CONTRIBUTING on intro repo together in my reorg PR?
Or should we do it later?

getting-practical.md Outdated Show resolved Hide resolved
getting-practical.md Outdated Show resolved Hide resolved
@BekahHW
Copy link
Member Author

BekahHW commented Mar 28, 2024

This is what I think as well. And removing the numbers for sure.

Do you want me to remove the numbers and adjust the instructions on CONTRIBUTING on intro repo together in my reorg PR? Or should we do it later?

I think we could do it now, but I'm hesitant to change anything other than the organization in that PR. Bc if something breaks, we want to be able to narrow it down quickly to fix it.

@adiati98
Copy link
Member

I think we could do it now, but I'm hesitant to change anything other than the organization in that PR. Bc if something breaks, we want to be able to narrow it down quickly to fix it.

In that case, let's do the organization for now. If it works, then we fix the numbers 😊

Copy link
Member

@adiati98 adiati98 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BekahHW

Some chapters on the README are following the title on each chapter and some are following the sidebar.

So, I standardized by following the exact title of each chapter.

If you're okay with this, this PR is ready to merge. πŸš€

@BekahHW BekahHW merged commit 0d5b1b3 into main Apr 3, 2024
@adiati98 adiati98 deleted the feat/get-practical branch April 4, 2024 04:35
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat: Add Let's get practical chapter
2 participants