Project Thread: Documentation Redesign

In early 2023, the Documentation site, also known as HelpHub, underwent a redesign and transitioned to a block Block Block is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. theme. You can learn more about this project in the original kick-off and launch posts.

The refresh of HelpHub set the stage for a redesign of Developer Resources (DevHub) last year, both part of WordPress.org WordPress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/ ’s Learn section. Ideally, both documentation sites should look and function similarly.

During the course of the DevHub update, design improvements were made, particularly to the homepage, and the block theme structure was refined. The new DevHub design was launched in December, so it’s now time for another iteration of HelpHub to ensure both sites are consistent.

Objective

Update HelpHub with the latest functionality and aesthetic introduced in the DevHub redesign. Add additional functionality to assist with content and user feedback management.

Overview

Given that the site is already a block theme, most of it won’t require changes. The redesign will concentrate on these specific areas:

  • Refreshing the homepage layout to be consistent with the DevHub redesign
  • Updating the block child theme Child theme A Child Theme is a customized theme based upon a Parent Theme. It’s considered best practice to create a child theme if you want to modify the CSS of your theme. https://developer.wordpress.org/themes/advanced-topics/child-themes/ . with enhancements from the DevHub redesign
  • Standardizing typography, especially the heading fonts, to align with other Learn WordPress.org sections ( #490 )
  • Enhancing the process for receiving and managing feedback
  • Refining how updates to documentation articles are tracked (improving the changelog)

This update aims to be completed within a few weeks. During the redesign process, we’ll assess any new issues that arise. Depending on their nature and urgency, they’ll either be addressed in this iteration or placed on the backlog for future iterations. 

Project updates will be provided here throughout the process, and any important resources will be added to the post for easy reference. Redesign feedback can be left in Figma , on GitHub , or here in the comments. Please continue to log any content-related issues in the Documentation Issue Tracker .

Timeline

Start: February 19th
End: March 26th

Resources

Project Members

Docs: @ estelaris
Design: @ fcoveram
Development ( Meta Meta Meta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress. ): @ ryelle
Cross-team coordination: @ ndiego

Props to @ estelaris , @ fcoveram , and @ ryelle for their help in shaping this project and reviewing this post. 

+make.wordpress.org/docs/
+make.wordpress.org/design/

# project-thread , # website-redesign