WordPress Developer Docs Shows Off a New Block-Based Redesign
WordPress.org has launched a major redesign of its Developer Documentation, transitioning to a modern block-based design. This update aims to enhance the user experience by providing a more intuitive and cohesive navigation system.
A Legacy of Documentation
Over the years, WordPress’s developer documentation, initially known as the Codex and now the WordPress Code Reference, has been a vital resource for developers. However, recent feedback highlighted inconsistencies and challenges, particularly with newer documentation like the JavaScript APIs and packages from Gutenberg. Developers often struggled with navigating the disparate designs and structures of various guides and handbooks.
A Modern Overhaul
In December, the entire Developer Resources subdomain on WordPress.org was relaunched with a fresh, new design. The new homepage, cohesive navigation, and improved readability have received rave reviews from the developer community. Screenshots comparing the new and old designs highlight the significant improvements made.
The project aimed to improve the structure and design while updating the content. The team opted to enhance the existing architecture rather than starting from scratch, allowing them to focus on fixing and updating content.
Collaborative Efforts
WordPress documentation is open to contributions from the community, much like WordPress core. This collaborative approach ensures that the documentation evolves with the input and expertise of a wide range of contributors. Some parts of the documentation are hosted on GitHub, making it easier for contributors to propose changes and improvements.
Learning Through Implementation
Updating the Developer Documentation site to a block-based design involved migrating from a classic theme to a block theme. This process provided valuable insights and lessons that the team shared with the broader developer community. Issues like version control for block themes were addressed, contributing to ongoing discussions and improvements within the WordPress ecosystem.
Ongoing Redesign Efforts
The redesign of WordPress.org is a multi-year project. Future updates will include enhancements to the rest of the WordPress Documentation, HelpHub, Forums, and Patterns Directory. The team is committed to making the redesign process as transparent and inclusive as possible, encouraging community involvement through public updates on the Make WordPress blog and dedicated Slack channels.
If you’re interested in contributing to the design or content of WordPress documentation, consider joining the WordPress Slack or following the Make WordPress blog. Your input can help shape the future of WordPress resources.
