Here is an attempt to add a README.txt file since your time is limited at the moment.

Hope that helps

CommentFileSizeAuthor
README.txt3.7 KBgmclelland
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

arhak’s picture

Title: Added README.txt » preparing a frist draft for README.txt
Priority: Normal » Critical
Status: Active » Needs work

thanks for the initiative
there are some minor conceptual errors I'll correct
but the more relevant problem within it would be the arrangement of topics

right now it is:
- description
- permission set up
- dependency (this should go first or not at all)
- demo site (this should be really brief or not at all)
- example use cases (very poor, almost misleading)
- things to keep in mind (this section could be last one if mentioned from the very start that it will appear bellow, I'm thinking that it will be required only once the user is getting familiar with the module and therefore it will contain more advanced settings and common misconfiguration pitfalls)
- permission set up (again? this should be unified in only one place)
- advanced settings (I would rename it to "Advanced property settings" since they seems to be related to policies and not global settings, but I would prefer not to quote what I said in the issue queue, since that means nothing to newcomers or even the average user, if you can't use your own words then my explanation won't help others either)

arhak’s picture

I have provided the best explanation I could for the following:
#727738: FAQ: is this another tracker-like module?
#746870: FAQ: what might be the problem with comment-related modules?
#766960: FAQ: purpose of the Producer/Consumer Policy

but I would prefer the words from other user(s) rather than mine, to ensure it is readable and comprehensible by others

PS: also there is #727816: FAQ: comment_driven_path & pathauto, but it is outdated (written for version unstable3) not sure if what it states is true for alpha releases, I haven't tried pathauto since then
nevertheless the driven_path module is a demonstrative module, so it can wait

arhak’s picture

NOTE
demo site was moved, it now resides at http://arhak.s4w.biz/tracker, however, if this new URL doesn't work then check the project page to know if it got moved again