Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

New sidebar & ToC theme#524

Merged
validbeck merged 13 commits intomainvalidmind/documentation:mainfrom
beck/sidebar-fiddlingvalidmind/documentation:beck/sidebar-fiddlingCopy head branch name to clipboard
Nov 14, 2024
Merged

New sidebar & ToC theme#524
validbeck merged 13 commits intomainvalidmind/documentation:mainfrom
beck/sidebar-fiddlingvalidmind/documentation:beck/sidebar-fiddlingCopy head branch name to clipboard

Conversation

@validbeck
Copy link
Collaborator

@validbeck validbeck commented Nov 13, 2024

Internal Notes for Reviewers

From #521

Looking at preview, I think we'd need to apply this to both the sidebar navigation and right-hand ToC (or neither) for a consistent feel.

LIVE PREVIEW

Old New
Screenshot 2024-11-13 at 10 59 03 AM Screenshot 2024-11-13 at 10 58 45 AM

@validbeck validbeck added the internal Not to be externalized in the release notes label Nov 13, 2024
@validbeck validbeck self-assigned this Nov 13, 2024
@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

@github-actions
Copy link
Contributor

PR Summary

This pull request introduces several enhancements to the CSS styles of the project, focusing on navigation elements and the Table of Contents (TOC). The key changes include:

  • Navigation Links: Adjustments have been made to the :before pseudo-elements of navigation links and dropdown items to exclude those within the TOC. This ensures that the hover effects are not applied to TOC links, maintaining a distinct style for the TOC.
  • TOC Styling: New styles have been added for the TOC, including padding, background color, and border styling. The TOC title and links have been styled for better visual distinction, with specific hover effects for active links.
  • Sidebar and Divider: The sidebar background color has been updated, and a new style for a sidebar divider with a dotted border has been introduced.
  • Headings: A dotted border has been added to h2 elements for visual separation.

These changes aim to improve the visual hierarchy and user experience of the navigation and TOC components.

Test Suggestions

  • Verify that navigation links outside the TOC have the correct hover effects.
  • Ensure that TOC links do not have the hover effects applied to other navigation links.
  • Check the visual appearance of the TOC, including background color, borders, and link styles.
  • Test the sidebar to confirm the new background color is applied correctly.
  • Validate that h2 elements have the new dotted border style.
  • Test across different browsers to ensure consistent styling.

@nrichers
Copy link
Collaborator

If you do want to do a solid background for the sidebar, I'd recommend something subtler that is closer to what the product does:

image

It's quite subtle. With a solid background, maybe NOT doing the same on the left and the right would be preferable, as the preview feels a bit busy to me. (With JUST a text colour change, I'd try the same on both sides.)

@nrichers
Copy link
Collaborator

BTW, this is an example of a simple but interesting box treatment: https://graphacademy.neo4j.com/courses/gds-product-introduction/

All the same, I'd use a box or solid background on only one side.

@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

1 similar comment
@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

1 similar comment
@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

1 similar comment
@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

@validbeck
Copy link
Collaborator Author

Why do you hate colour so much, Nik?? 😭 😭 😭

I stole some other greens and some hover states from the platform, and I'm willing to live with this if you are:

Screenshot 2024-11-13 at 3 41 06 PM

Adjusted the drop-down as well since the hover state for the sidebar doesn't play nicely with BG shifts:

Screenshot 2024-11-13 at 3 44 00 PM

Simplified training to one .css sheet (and updated the conventions to match):

Landing Registration Pages
Screenshot 2024-11-13 at 3 44 32 PM Screenshot 2024-11-13 at 3 41 37 PM

@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

Nik apologizes to Beck for annoying them and expresses his gratitude and thanks for this PR. :shipit:

@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

@validbeck validbeck merged commit 9404920 into main Nov 14, 2024
@validbeck validbeck deleted the beck/sidebar-fiddling branch November 14, 2024 00:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Morty Proxy This is a proxified and sanitized view of the page, visit original site.