About the Wonderflux guide

Wonderflux has been built from the ground-up to be the most flexible, creative WordPress theme framework available. It has loads of great features that allow you to interact with the code and rapidly develop highly sophisticated, unique WordPress themes.

As you can imagine – documenting all the functionality in Wonderflux is quite a daunting task. It’s far more fun to be coding on the actual Wonderflux theme core code than writing up content for this guide (sorry, but it’s true!) Efforts have been made to complete inline documentation, but this is only useable to more advanced developers and doesn’t suit most people. The fact of the matter is that it is going to take a while to complete the documentation of every part of Wonderflux.

Documentation development

Documentation will be started mostly ‘from the top’ with the hooks, and be working through the most useful and important functions, so after a while this will hopefully build a good resource for us all to use!

Inline documentation in the core of Wonderflux on core functions/classes will be reviewed as they are documented, cleaned up and maintained in PHPdoc format. All other inline comments and documentation will be removed in the core code as it is documented on this site.

Guide site development background

The guide runs on WordPress (of-course!) with a custom Wonderflux child theme developed by Jonny Allbut. The Wonderflux layout is pretty simple, but what makes the theme special is the use of custom posts types (for every type of content – for example filters) and some pretty extensive use of taxonomies that interlink where relevant across the custom post types. This provides the ‘glue’ that makes the relationships between documentation possible.

With a handful of custom theme functions and a bit of CSS this provides (what we hope) is a solid reference guide for everyone to use. There are a few bits of functionality that will be launched as the content grows, along with a few potential ideas like incorporating comments and some community interaction with the guide.