Documentation happens in many locations on a project like infraspective. There is the README, the wiki, the docs folder (maybe even a blog post when I get to it)...
With so many locations, it is easy for that documentation to get "out of sync". So, I need to clean up and organize the documentation so that it is:
Ubiquitous : Whether you are in a console, on the web or browsing the source, the documentation should be available
Versioned : As features get added, modified or removed, the documentation needs to be able to map to a point where it is relevant and accurate.
Uniform : The names, links, references and structure of the documentation should be the same regardless of where it is being viewed
Conventions
The canonical source of documentation is the ./docs folder.
The format is markdown (all files will have the .md extension).
PlatyPS will be used to synchronize comment-based help and the markdown
Tasks
[x] #74
[ ] Remove Comment Help and replace with .EXTERNALHELPFILE keyword
Documentation happens in many locations on a project like
infraspective. There is the README, the wiki, the docs folder (maybe even a blog post when I get to it)...With so many locations, it is easy for that documentation to get "out of sync". So, I need to clean up and organize the documentation so that it is:
Conventions
./docsfolder..mdextension).Tasks
.EXTERNALHELPFILEkeyword