WordPress / wporg-developer

WordPress.org Developer theme
https://developer.wordpress.org/
59 stars 22 forks source link

Code reference should have the handbook sidebar. #29

Open tellyworth opened 2 years ago

tellyworth commented 2 years ago

Discussed in https://github.com/WordPress/wporg-developer/discussions/1

Originally posted by **StevenDufresne** May 23, 2022 Related to https://github.com/WordPress/wporg-developer/discussions/2. This makes the argument that the Code Reference should have the same sidebar as the [handbooks](https://developer.wordpress.org/block-editor/). ## Why - The code already exists - We want to create a consistent wp.org experience - We can improve the handbooks at the same time. Here's how it could look like: ### Potential Improvements: There are tickets in the meta repo that speak to this, although I don't have them in hand. 1. Use more of the page. 2. Fix the way items are visually nested 3. Smarter logic to expand the active section (to expand you have to click the arrow down, which is small,... clicking the title does something different) 4. Related: Make the search results appear in-line
apeatling commented 2 years ago

It would be a huge improvement to remove the third level nesting in the navigation, it's way too much to have that nested in the sidebar. Lots of examples on the Gutenberg docs.

Instead use the top second level items as an overview pages that list out the third level items. Then make sure there's a back or breadcrumb link back on the third level item pages.

adamwoodnz commented 9 months ago

This didn't make it into the current redesign. @StevenDufresne is this still something we should raise with design, or should it be closed?

StevenDufresne commented 9 months ago

I don't think it has priority right now, but I'm personally in favor of something that makes navigating functions more straightforward.