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

fix: shorten long titles to fit the sidebar #55

Merged
merged 9 commits into from
Feb 17, 2024
Merged

Conversation

adiati98
Copy link
Member

Description

This PR shortens long titles to fit the sidebar.

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

Fixes #54

Mobile & Desktop Screenshots/Recordings

shorten titles sidebar 1

Steps to QA

  1. Open the course.
  2. Look at the sidebar.

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?

@adiati98 adiati98 self-assigned this Feb 11, 2024
@adiati98
Copy link
Member Author

adiati98 commented Feb 11, 2024

@jdwilkin4, as you wrote this chapter, I need your thoughts here. 😊

### Where to Place the Installation Guide
The best place for installation instructions should be at the top of your project's `README.md` file, as it is the most accessible file for your contributors.

I'm thinking of removing the subtitle and including this as part of the "An Installation Guide" section rather than a subsection. The reason is because in some sections, where to put the files are mentioned in the sections and don't have subsections for that matter.

It could be something like:

- ### Where to Place the Installation Guide
-
- The best place for installation instructions should be at the top of your project's `README.md` file, as it is the most accessible file for your contributors.
+
+ The installation guide is best placed at the top of your project's `README.md` file, as it is the most accessible file for your contributors.

@adiati98
Copy link
Member Author

I'm also thinking to change the "What is an Open Source Maintainer?" title on the sidebar to be "Open Source Maintainer" to avoid duplication with the following subtitle.

Here is the screenshot from the current state:

titles

Any thoughts?

@jdwilkin4
Copy link
Contributor

I'm thinking of removing the subtitle and including this as part of the "An Installation Guide" section rather than a subsection. The reason is because in some sections, where to put the files are mentioned in the sections and don't have subsections for that matter.

Yeah, that's fine πŸ‘

I'm also thinking to change the "What is an Open Source Maintainer?" title on the sidebar to be "Open Source Maintainer" to avoid duplication with the following subtitle.

That makes sense πŸ‘

@adiati98
Copy link
Member Author

@jdwilkin4 I made the changes and this is ready for review whenever you have time. 😊

@adiati98 adiati98 requested a review from jdwilkin4 February 17, 2024 22:01
@jdwilkin4 jdwilkin4 merged commit ab72496 into main Feb 17, 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.

Bug: Long titles are cut on the sidebar
2 participants