Add commenting on API objects
Migrated issue
Reported by: hunmonk
discussion with some fellow devs has led me to explore the idea of making the api module run through the node system -- ie, any api 'objects' (functions, files, constants, topics, php functions, etc.) would be mapped to one object per node.
advantages:
- more robust searching for free: the main documentation would be made the body of the node, so regular searches via search module would provide another search vector.
- comments: users would be able to add comments to further clarify the doc, ala php.net
- bookmarks: using bookmark module, users could have a handy block of links to their most used doc sections.
- ratings/reviews: using voting modules, posted comments could be community moderated by popularity
...and probably half a million other things we get for free, or are easily accessible, because we are interfacing with drupal's primary content system.
disadvantages:
- performance hit: going through the node system could be slower than the current system, which might slow down the doc site for everybody.
- more code to maintain: the module will probably get even more complex if we take this route.
- more site maintainance: if we're installing other contrib modules to get some of the above features, then it will be more maintenance/upgrade work for the api.drupal.org folks.
i'd like to get some feedback on this idea, and if it seems well loved, then i'll look at tackling it. :)