Detailed documentation for all functions

[NowinskiK]

Pull Request

Documentation (MD format) generated for all functions. #9

Pull Request (PR) description

Task list

• The PR represents a single logical change. i.e. Cosmetic updates should go in different PRs.
• Added an entry under the Unreleased section of in the CHANGELOG.md as per format.
• Local clean build passes without issue or fail tests (build.ps1 -ResolveDependency -Tasks build, test).
• Comment-based help added/updated.
• Examples appropriately added/updated.
• Unit tests added/updated..
• Integration tests added/updated (where possible).
• Documentation added/updated (where applicable).
• Code follows the contribution guidelines.

[github-actions]

Linux Test Results

4 864 tests   4 863 ✅  42s ⏱️
  591 suites      1 💤
    1 files        0 ❌

Results for commit 4bf11c8.

♻️ This comment has been updated with latest results.

[github-actions]

WinPS51 Test Results

5 068 tests   5 067 ✅  45s ⏱️
  592 suites      1 💤
    1 files        0 ❌

Results for commit 4bf11c8.

♻️ This comment has been updated with latest results.

[github-actions]

WinPS71 Test Results

5 068 tests   5 067 ✅  43s ⏱️
  592 suites      1 💤
    1 files        0 ❌

Results for commit 4bf11c8.

♻️ This comment has been updated with latest results.

[jpomfret]

@NowinskiK - this is just manually generating the docs right? I think on the issue @Frank-Geisler said he has some automation for this?
#9 (comment)

Would be good to at least have a GitHub action that uses PlatyPS module to create the files - then the next step would be to turn it into a static site.

The recording isn't out yet but there was a good session on this whole process at PSConf last week - code and slides are here if that helps: https://github.com/psconfeu/2025/tree/main/Shaun%20Lawrie/automagical-documentation/demo

[NowinskiK]

Yes, that's a manual script for now. It would be good to start with something once we have nothing at the moment.
If you or Frank have the capacity for additional automation, please feel free to do so.
Then we could use this PR as a subtask of #9. Can we complete this one and I will create subtask in #9?
And you're right - Static site would be the next step - we have a separate issue for that: #3 - we need details in there before we start.

[tiagobalabuch]

This looks fantastic to me! Thank you so much for your excellent work!