Readme creation / cleanup update

[PrzemyslawKlys]

Is there a way to create README.MD like PlatyPS does?

I tried using Wiki, but I don't see any results. Also is it possible to clear any deleted commands from doc?

[StartAutomating]

@PrzemyslawKlys

For creating the README:

I normally do this by hand / with PipeScript's help (see almost any repo's README.ps.md). This allows me to hand-craft most of the content I want and templatize stuff like command tables and examples.

I haven't found a "perfect" default for this yet. I'm open to suggestions on a "good enough" default.

For deleting the help content that's no longer "correct"

This one is a trickier problem. The long story made short is that it's easy to clear a directory, and that would prevent manually editing docs (which would be bad). It's very hard to figure out that a file has become an orphan.

I'm open to suggestions here. Changes would have to be tracked in an additional file in order for us to know that "the file was generated by the last build, but not this build".

Hope this helps / Lemme know what you think

[SamErde]

@PrzemyslawKlys, I'm curious if this is relevant to your question. In my PSPrworkout module, I have a GitHub action that publishes MkDocs. I wanted to combine the PlatyPS-generated readme with my own content, so this action has a PowerShell scriptblock that combines two files to create a new readme.
https://github.com/SamErde/PSPreworkout/blob/cf68aa76afe1f2474295ac0e0cc93ecb6c354a1e/.github/workflows/Deploy%20MkDocs.yml#L36

It basically lets me use separate files for the header, content, and footer of the repository's readme. It's a bit hacky right now but could probably be polished into a proper script or action. What do you think?