Write docs outside of artifacts directory about catesta

[techthoughts2]

This is functional code, and can be un-commented and utilized.

This was commented out because some module authors opt to reverse their help workflow once the markdown is published.

Initial help based comments -> Markdown generated -> External help generated -> Comment based help replaced with external help reference.

At this point some module authors stop updating comment based help and elect instead to edit the markdown directly and then regen from that point using platyPS directly.

Module generators by their nature are somewhat opinionated and I hadn't made a decision if replacing the top level docs on each build was the right call.

Thus, this was commented out.

In review, I think Catesta is driven from a design model that derives the 'source of help truth' from the comment based help. So, I will get this un-commented and documented as the default behavior.

[TsekNet]

Noticing that you have code to do this already:

    # here you could move your docs up to your repos doc level if you wanted
    Write-Build Gray '        Overwriting docs output...'
    Move-Item "$($script:ArtifactsPath)\docs\*.md" -Destination "..\docs\" -Force
    Remove-Item "$($script:ArtifactsPath)\docs" -Recurse -Force -ErrorAction Stop
    Write-Build Gray '        ...Docs output completed.'

This seems to be commented out in the module available from PSGallery. Assuming something wasn't working here and thus this was commented out, and the changes in this repo haven't been pushed to PSGallery just yet?

[TsekNet]

Sounds reasonable, thanks for the context!