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

Update chapter list #305

Merged
merged 6 commits into from Nov 1, 2023
Merged

Update chapter list #305

merged 6 commits into from Nov 1, 2023

Conversation

adamwoodnz
Copy link
Contributor

@adamwoodnz adamwoodnz commented Oct 25, 2023

Closes #265, #310, #313

Updates styling of chapter list:

  • Font weights, colors, list item styles

Note: Does not include #306

Note also that the root handbook page is always shown in the current prod chapter list, so 'Best Practices' being shown on the WPCS page in the screenshots below is consistent with the other handbooks.

Screenshots

Coding standards

localhost_8888_coding-standards_wordpress-coding-standards_(Desktop)

Block Editor

localhost_8888_block-editor_reference-guides_theme-json-reference_theme-json-living_(Desktop)

Advanced admin

localhost_8888_advanced-administration_security_backup_(Desktop)

@adamwoodnz adamwoodnz self-assigned this Oct 25, 2023
@adamwoodnz adamwoodnz added this to the MVP milestone Oct 25, 2023
Base automatically changed from update/266-coding-standards to trunk October 26, 2023 00:15
@adamwoodnz adamwoodnz force-pushed the update/265-chapter-list branch 2 times, most recently from 4093118 to 9985277 Compare October 26, 2023 02:26
@adamwoodnz adamwoodnz requested a review from a team October 26, 2023 02:46
@jasmussen
Copy link
Collaborator

jasmussen commented Oct 30, 2023

Nice, this is a big win. I think it can in principle land as is.

That said, per a recent revisit to this section, some opportunities for simplification were surfaced. In the case of the chapters list, it was mainly some small things:

Screenshot 2023-10-30 at 10 21 05

  • Smaller chevron (chevron-small) from the WordPress Design Library.
  • Chevron pointing right means collapsed, pointing down means open
  • 3x3 dot instead of 4x4 dot
  • Small margin tweaks.

You can dive into the Figma here.


I noted some larger changes as well, which I'll show here for reference. I wouldn't call any of them urgent or blocking, but they simplify the overall appearance a bit, and could be applied across any section that uses chapters or tables of content, including Documentation.

Expanded, collapsed, scrolled

Responsive

Notably the removal of dots and the background from the TOC. Both scroll with you down the page. "Back to top" can appear as you scroll a bit. Most of those changes are in the "enhancements" category and should not block anything, or even need be part of a V1. I can create issues separately if need be, but wanted your take on it first.


Also a think for the future, and IMO also in the nice-to-have category is the expand/collapse behavior of the left sidebar. Here's the SVG for the new icon for that, which has also been added to the WordPress Design Library:

<svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M18 17.5v-11h-1.5v11H18Z" fill="#1E1E1E"/><path d="m6 12 4.25-4.5M6 12h9m-9 0 4.25 4.5" stroke="#1E1E1E" stroke-width="1.5"/></svg>

@adamwoodnz
Copy link
Contributor Author

Thanks for the feedback @jasmussen !

In the case of the chapters list, it was mainly some small things

👍 I'll make these changes in this PR I think

I can create issues separately if need be

Yes please, a new issue in wporg-mu-plugins for the ToC changes. I might do the background and bullet changes quickly, then follow up with the rest.

Also a think for the future, and IMO also in the nice-to-have category is the expand/collapse behavior of the left sidebar

👍 I've got a separate issue for this #306

I'll also tighten up the column spacing, but that doesn't need an issue.

- Reduce width of chapter list and ToC
- Retain column layout for chapter list and content on tablet
Smaller icons and tighter spacing
@adamwoodnz
Copy link
Contributor Author

Chapter list and responsive layout updated:

Screenshots

Monitor

localhost_8888_advanced-administration_server_web-server_httpd_(Monitor) (1)

Desktop Tablet Mobile
localhost_8888_advanced-administration_server_web-server_httpd_(Desktop) (1) localhost_8888_advanced-administration_server_web-server_httpd_(iPad) localhost_8888_advanced-administration_server_web-server_httpd_(Samsung Galaxy S20 Ultra) (1)

@adamwoodnz adamwoodnz merged commit 1892b50 into trunk Nov 1, 2023
1 check passed
@adamwoodnz adamwoodnz deleted the update/265-chapter-list branch November 1, 2023 01:14
@jasmussen jasmussen mentioned this pull request Nov 6, 2023
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Chapter list update
2 participants