-
-
Notifications
You must be signed in to change notification settings - Fork 0
feat: adding content for the Issues and PRs section #8
Conversation
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.
Hey @jdwilkin4,
I left here some reviews for typos and wording adjusment suggestions. I also left some thoughts for your feedback. Thank you! 😊
Co-authored-by: Ayu Adiati <[email protected]>
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.
@jdwilkin4 I left some more reviews here. And as we want to be consistent with "pull request" instead of "PR", let's replace them. :)
Co-authored-by: Ayu Adiati <[email protected]>
…s Bug Fixes section
This should be good now because all of the changes have been applied. |
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.
@jdwilkin4 I just noticed the sidebar.
I actually like that the titles are started with "How to ...".
But on the sidebar, when the title is too long, it's shortened and hard to see what it is unless user hover over it. And it's even harder on mobile.
I'm trying to figure out if we can go without "How to" or a way to shorten the titles when it's possible.
Any thoughts?
I need one confirmation from @BekahHW later on.
Do we want to have the same title (h1) on page as well as on sidebar?
If so, we might want to change it. Otherwise, this looks good to me. 👍
We don't need to have the same title in the sidebar. I think the sidebar should be easily read, so the shorter the better. The H1 should connect. So if the sidebar is 'triaging issues', the h1 could be 'how to triage issues' |
@BekahHW, from h2 forward, the sidebar titles are following the exact title on the page. Do you think we should adjust the subtitles to be shorter? |
I think that would make it easier for ppl taking the course, right? |
You mean make them shorter, right? It surely would be easier to see the title and navigate from the sidebar. |
…auced/maintainer-intro-course into feat-4-issues-prs-section
@BekahHW I adjusted the titles to fit the sidebar. Not all fits, but most are. |
@adiati98 this looks good to me. I'll defer to you for final approval though. |
Description
This PR is responsible for adding the content for dealing with issues and PRs as an open source maintainer.
What type of PR is this? (check all applicable)
Related Tickets & Documents
closes #4
Mobile & Desktop Screenshots/Recordings
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?