WordPress’ Documentation Team will be hosting an online Contributor Day on October 25, 2022, ahead of WordPress’ anticipated 6.1 release the following week. Milana Cap, who has been volunteering with the Documentation team for years and is currently sponsored by XWP, announced the event this week. “The primary goal is to catch up with a…
Last month the WordPress Documentation Team announced a ban on links to commercial websites within the official docs. These include the HelpHub, Code Reference, Plugin and Theme Developer Handbooks, Block Editor Handbook, and the Common APIs Handbook. The reason behind the ban was that heavily policing commercial links placed too much responsibility on the documentation team, when they are already working with limited…
This week WordPress’ Documentation team announced a ban on links to commercial websites in a revision to its external linking policy: During discussion about external linking policy, we came to conclusion that we won’t allow, at least in the beginning and for the time being, any commercial blogs. So before you start arguing that some…
WordPress developers Milana Cap and Jonathan Bossenger are starting a fundraiser for improving Gutenberg developer documentation. The conversation began yesterday when Cap tweeted about how documentation is often overlooked when companies hire full-time contributors to work on WordPress. “When your community is unable to learn your software then you have no contributors,” Cap said. “Documentation…
ThemeBeans founder Rich Tabor has open sourced WPThemeDoc, the template he uses for documenting his commercial WordPress themes. Tabor is also the creator of Merlin WP, a theme onboarding wizard that makes setup effortless for users. After applying his aesthetic talents to the documentation aspect of his business, he decided to package up his efforts…
This post was contributed by guest author Jeff Matson. Jeff is the head of documentation for GravityForms. He is the creator of the Heartbeat Control WordPress plugin and is a fan of the 90s. Often times, documentation is the most underrated piece of the development process. When we look at rockstars in the WordPress community,…
A product’s documentation is usually a strong indicator of its quality, but creating docs is often the least exciting aspect of launching something new. Products that lack documentation can create a greater support burden, forcing you to write docs as a defensive measure after the fact. The free Documentation Post Type plugin may be just…
If you use WordPress, chances are that you’ve run into the WordPress Codex. The Codex is a community maintained collection of documentation, hooks, filters, best practices, and other information related to WordPress. With various handbook projects underway, I’ve been wondering what the future of the Codex is. To find out, I got in touch with…
When you have a question about a WordPress theme, where do you look for more information? Theme developers make use of a myriad of documentation methods, from bundling docs to linking to external resources. If you’ve already created a theme and taken the time to document it, then your next challenge is to make its…
The WordPress ecosystem is made up of thousands of websites, code repositories, blogs, forums, etc. To a new WordPress user, it can be intimidating or downright frustrating figuring out where to go. My goal with this post is to provide a map for those who are brand new to the world of WordPress to be…
Something exciting is happening in the world of WordPress documentation. Very soon all of the hooks used throughout the core are going to be documented. An initiative is now underway to bring inline docs for hooks into the upcoming WordPress 3.7 release. I can see some of you jumping up and down and celebrating wildly…
If you’re new to WordPress development and looking for a way to learn about the various filter hooks that reside within WordPress, you’ll want to bookmark and view the new Filters of The Day Website started by Drew Jaynes. The site publishes three WordPress filters a day with snippets of example code that shows the…
In an effort to figure out where resources should be applied to improve the documentation efforts of the WordPress project, there is an open survey that will be ongoing for the next few weeks. The survey is composed of 12, easy to answer questions which shouldn’t take longer than 5 minutes to answer. Along with…
As we near the release of WordPress 3.5, the docs team is looking for your help to insure that the Codex has all of the necessary information pertaining to the new release. So far, there is a hefty list of items that need to be added or amended in the Codex, especially as it pertains…
WPDocs was passed along on the hackers mailing list this morning. It was created by the folks over at The Dextrous Web which is a web development company that focuses on building websites for the public sector. The WordPress API along with files are located in a sidebar on the left with the explanation provided…