-
-
Notifications
You must be signed in to change notification settings - Fork 0
feat: Add new chapter on practical application #35
Conversation
@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. |
There was a problem hiding this 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! π
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.
.
βββ assets/
βββ images
βββ gif
|
There was a problem hiding this 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. π
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? |
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 π |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. π
Description
closes #31
What type of PR is this? (check all applicable)
Related Tickets & Documents
Mobile & Desktop Screenshots/Recordings
Steps to QA
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?