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

feat: adding content for the Issues and PRs section #8

Merged
merged 20 commits into from
Jan 4, 2024

Conversation

jdwilkin4
Copy link
Contributor

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)

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

Related Tickets & Documents

closes #4

Mobile & Desktop Screenshots/Recordings

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?

@jdwilkin4 jdwilkin4 self-assigned this Dec 13, 2023
@jdwilkin4 jdwilkin4 changed the title feat: adding content for Issues and PRs section feat: adding content for the Issues and PRs section Dec 13, 2023
@jdwilkin4 jdwilkin4 marked this pull request as ready for review December 19, 2023 05:00
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.

Hey @jdwilkin4,
I left here some reviews for typos and wording adjusment suggestions. I also left some thoughts for your feedback. Thank you! 😊

Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
@jdwilkin4 jdwilkin4 requested a review from adiati98 December 27, 2023 10:26
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.

@jdwilkin4 I left some more reviews here. And as we want to be consistent with "pull request" instead of "PR", let's replace them. :)

Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
Issues-and-Pull-Requests.md Outdated Show resolved Hide resolved
@jdwilkin4 jdwilkin4 requested a review from adiati98 December 30, 2023 08:05
@jdwilkin4
Copy link
Contributor Author

@adiati98

This should be good now because all of the changes have been applied.

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.

@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.

hover over sidebar

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. 👍

@BekahHW
Copy link
Member

BekahHW commented Jan 2, 2024

@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.

hover over sidebar

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'

@adiati98
Copy link
Member

adiati98 commented Jan 2, 2024

@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?

@BekahHW
Copy link
Member

BekahHW commented Jan 2, 2024

I think that would make it easier for ppl taking the course, right?

@adiati98
Copy link
Member

adiati98 commented Jan 2, 2024

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.

@adiati98
Copy link
Member

adiati98 commented Jan 3, 2024

@BekahHW I adjusted the titles to fit the sidebar. Not all fits, but most are.
Please let me know if I need to change anything here. Below is the screenshot after the titles are shortened:

shorten titles sidebar

@BekahHW
Copy link
Member

BekahHW commented Jan 4, 2024

@adiati98 this looks good to me. I'll defer to you for final approval though.

@adiati98 adiati98 merged commit 12f9636 into main Jan 4, 2024
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: Issues and PRs section
3 participants