Module Documentation

[SQLCanuck]

You may wish to consider one module dependency of platyPS, in order to provide automated module documentation creation.

If used it would use a folder "\dist<modulename\en-US", to hold the resulting MAML file to the final module.

Adding a "docs" folder to the project root level could also be beneficial, to hold the intermediary Markdown documentation files. As these can be used to provide web based module documentation as well.

The documentation creation could be integrated as one of the steps in Invoke-MTBuild.

[belibug]

Thanks for submitting this issue. I've read a lot about platyPS and have tried to incorporate it into my own modules, but I always end up using in-place help within the functions.

The "docs" folder sounds interesting. Do people typically publish documentation (in Markdown or other text formats) with their modules? If so, how do users access these docs when they download a module from PSGallery or another repository, unless, of course, they use platyPS or another tool to convert the files to XML help files?

[SQLCanuck]

Thanks for submitting this issue. I've read a lot about platyPS and have tried to incorporate it into my own modules, but I always end up using in-place help within the functions.

The "docs" folder sounds interesting. Do people typically publish documentation (in Markdown or other text formats) with their modules? If so, how do users access these docs when they download a module from PSGallery or another repository, unless, of course, they use platyPS or another tool to convert the files to XML help files?

platyPS utilizes the in-place help within the functions to generate the Markdown and MAML (Micrsosoft XML Help format). That XML help documentation, is what Get-Help would utilize.

As for the intermediary Markdown files platyPS would create in the docs folder. That markdown could be simply linked from the ReadMe to provide web based help, or even as a source for something like Hugo to generate a static website for the documentation.

[belibug]

I would like to get started on platyPS, if you can do a pull request with some skeleton or structure that would be really helpful.

[SQLCanuck]

I'll try to get something put together and create a PR when ready.