Added DOCUMENTATION.md

[awsles]

Documentation in a single markdown page in github for convenience. The page was generated using the built-in help text within the module.

[nightroman]

Hi @lesterw1 Thank you.

I am not sure yet that I want to add this documentation to the repository. It might be more convenient than console help, for some users, yes. But for me it comes with maintenance and this is not convenient, unfortunately. To start with, I do not know how this file is generated, if this way is, say, adoptable, and etc.

As for the file itself, it looks nice except descriptions of examples perhaps, the font is way too large.

[nightroman]

As far as I understand, this script is used for generation -- Get-MarkdownFromModule.ps1.

I like the idea of the script. But this tool is too simple at the moment in order to be adopted and used for maintaining the suggested online documentation.

There are multiple issues, observed and potential. For example:

• The generated file is treated as binary by git (due to replacing \n instead of \r\n?).
• Code examples are funny formatted, as I mentioned before, e.g. PowerShell line comments (#) become markdown headers.
• I am not sure that markdown escaping is performed, there is a chance that special characters in topics may break formatting.

[nightroman]

I am closing this PR. The idea is reasonable and promising as such. But I am not sure that the tooling for maintaining this sort of documentation is ready enough.