Package documentation

Is there documentation or a tutorial on using the MIGx package manager?

I would LOVE to have some documentation. It'd have saved me having to trawl the forums, the innards of XPDO API docs and the MIGX source itself. I guess Bruno is pretty busy, but I am sure having some form of documentation would help him reduce the amount of time needed to give support on the forums.

Without docs, I often spend a very long time trying to determine whether something is a bug or is simply not working correctly because I am not using the component correctly. It usually ends up being something minor, but just not obvious.

Docs are king. And good docs take time and skill.

Quote from: Everettg_99 at Jun 20, 2013, 07:13 PM

Docs are king. And good docs take time and skill.

Absolutely. Bruno, is there any way you would prefer that MIGX users aid you in documenting the component? I would love to at least have descriptions in MIGX along with the field names. You've already provided descriptions for many of them on the forums at the request of users, but they can be tough to track down. I would be willing to help with such an effort, but the only way I can see it happening is if the _build folder was committed to the git repo so users can make contributions. Is there another way?

What are your feelings on this, Bruno?

I would be happy, if people would help with documentation.

Many things which are clear and logical for me, may not for others.
So I don't know what people would like to be documented and...
I prefer to spend my time in writing code and help people with in individual situations than trying to write documentation for all possible scenarios, which is not possible.

I think my _build - folder is a bit useless for you, because I'm building the package with myComponent/myComponentMigxUI
and you don't need the build-folder for contributing to the extra.