Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: shorter doc nav section titles #4613

Merged
merged 1 commit into from Nov 2, 2023
Merged

fix: shorter doc nav section titles #4613

merged 1 commit into from Nov 2, 2023

Conversation

deboer-tim
Copy link
Collaborator

@deboer-tim deboer-tim commented Nov 2, 2023

What does this PR do?

A few of the section titles in the doc nav are long, which makes it harder to scan for a topic. Worse, some of these wrap to two lines making the layout not flow very well.

Screenshot/screencast of this PR

Before:

Screenshot 2023-11-02 at 8 52 18 AM

After:

Screenshot 2023-11-02 at 8 56 01 AM

What issues does this PR fix or reference?

N/A

How to test this PR?

yarn website:dev

@deboer-tim deboer-tim requested review from dgolovin and feloy and removed request for a team November 2, 2023 12:54
A few of the section titles in the doc nav are long, which makes it harder to scan
for a topic. Worse, some of these wrap to two lines making the layout not flow very
well.

Signed-off-by: Tim deBoer <git@tdeboer.ca>
Copy link
Collaborator

@slemeur slemeur left a comment

Choose a reason for hiding this comment

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

+1

@benoitf
Copy link
Collaborator

benoitf commented Nov 2, 2023

I like short names but now I have a hard time to figure out the sorting used in the sidebar

I don't know if we can have some separators or something else but let say I want to look quickly as it's not sorted in alphabetical order or it's not in some main sections I still think navigation is harder

@deboer-tim
Copy link
Collaborator Author

+1 to @benoitf comments. Separate PR ;-), but I think some subtle dividers or something to break up the list/show sections would be helpful.

@deboer-tim deboer-tim merged commit bba1125 into main Nov 2, 2023
13 checks passed
@deboer-tim deboer-tim deleted the short-nav branch November 2, 2023 15:14
@podman-desktop-bot podman-desktop-bot added this to the 1.6.0 milestone Nov 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants