Doc generator

[Redsandro]

Created simple yet terribly convenient script to create the Helper Overview markdown documentation (and added* existing lines from Wiki to script file comments to keep everything in one place).

*) Also included fix to Get-BinRoot since I need to edit the script anyway

This takes care of the offtopic yet relevant comment by @Nilzor in #421 (comment) and every future comment by anyone talking about Helper documentation.

[AnneTheAgile]

docs are a hot topic for me :). What merge conflicts are there? I can't see how to determine what they are?

Then, if that is ok, is this PR slated to be merged or are docs handled differently now?
AnneTheAgile

[Redsandro]

I have no recollection of this pull request. No idea what I was trying to do.

[gep13]

@Redsandro I believe I am right in saying that this was an attempt to provide "one source of truth" for the documentation for the wiki. Currently, we document a helper method in two places. In the ps1 file and also in markdown in the wiki. This is currently done as a manual task, and subject to human error, and becoming out of date.

This PR was an attempt to generate the markdown for the wiki directly from the help documentation in the ps1 files, so at the very least, they were the same, and we only have to update it in one place, i.e. the ps1 files, and then simply update the wiki articles with this helper.

[Redsandro]

I guess it used to work, but it wasn't picked up, and now it needs work.

I don't have time to look into this right now. Feel free to pick this up. If not, Thanks for inquiring. :) Here's a picture of some shaved ice as a thank you: 🍧

[AnneTheAgile]

@gep13 & @Redsandro , ok thank you! I do indeed like this idea.
To see the merge conflicts, I must pull down Redsandro:docGenerator [1] branch and try to pull in this main master [2], right? And then naturally I should see them. I had thought I should be able to see it here on github visually, but I guess not. That's ok, just wanted not to miss something. Ty @Redsandro for the ice and nice lady/gentleman logo!
AnneTheAgile
[1] https://github.com/Redsandro/chocolatey-origin/tree/docGenerator
[2] https://github.com/chocolatey/chocolatey

[ferventcoder]

If this is going to get picked up, adjust over to
https://github.com/chocolatey/choco please

On Tuesday, January 27, 2015, AnneTheAgile [email protected] wrote:

@gep13 https://github.com/gep13 & @Redsandro
https://github.com/Redsandro , ok thank you! I do indeed like this
idea.
To see the merge conflicts, I must pull down Redsandro:docGenerator [1]
branch and try to pull in this main master [2], right? And then naturally I
should see them. I had thought I should be able to see it here on github
visually, but I guess not. That's ok, just wanted not to miss something. Ty
@Redsandro https://github.com/Redsandro for the ice and nice
lady/gentleman logo!
AnneTheAgile
[1] https://github.com/Redsandro/chocolatey-origin/tree/docGenerator
[2] https://github.com/chocolatey/chocolatey

—
Reply to this email directly or view it on GitHub
#458 (comment).

Rob
"Be passionate in all you do"

http://devlicio.us/blogs/rob_reynolds
http://ferventcoder.com
http://twitter.com/ferventcoder