Recently i talked with quite drupal developers and they all complained that there is no documentation availible how to write ctools plugins.

Bascially they just failed to realize that there is documentation within ctools itself. Perhaps it would help to write something on the project page like:

<h3>Documentation</h3>
If you want to understand how to write custom ctools plugins the best place to look is the ctools_plugin_example directory provided by ctools itself. It provides a lot of examples for a bunch of plugins. Feel free to improve it by making patches.

Comments

oadaeh’s picture

oadaeh commented

Probably, this could be better stated by saying something like this:

The documentation for CTools is in <a href="http://drupal.org/project/advanced_help">Advanced help</a> pages. There is also example code included with the module in the ctools_plugin_example and ctools_ajax_sample directories.
  • An understanding of the Plugin system will come from both reading the documentation and reading through the examples together. Only pointing to the examples, totally leaves out the documentation that describes what the examples are doing.
  • Singling out the Plugins tool, makes it seem that the documentation and examples for other tools are not included, which is not true.
merlinofchaos’s picture

merlinofchaos commented

I sometimes feel that all levels of documentation, no matter how much, are basically "no documentation" to developers.

charlie-s’s picture

charlie-s commented

I think this is a good idea. If you were to visit http://drupal.org/project/ctools and do a find for the word "documentation" you would get no results (outside of drupal.org's header and footer documentation links). When I grab a module that has no readme or similar, I typically head to the project page and look for the word "documentation" link on the right sidebar or in the project description. In fact, the Views project page is a good example of what makes me, as a developer, quite happy.