PowerShell-Docs VS DocFX

--% is a half-baked solution and has various inherent issues. It should not be relied upon if alternative solutions exist.

They seem to have an internal system that is triggered by commits on the main branch on those repositories that contain docs. For example, if you look at https://github.com/MicrosoftDocs/PowerShell-Docs, and click on the commit checks for the latest main commit (green checkmark next to the commit), there is one check "OpenPublishing.Build" that leads to the report of where the files were uploaded: https://opbuilduserstoragepublic.blob.core.windows.net/report/2022%5C5%5C5%5C6ff7e8c3-dfc6-3ebd-da5a-d5e2ff43de8f%5CPullRequest%5C202205052157488348-8793%5Cworkflow_report.html?sv=2021-04-10&se=2022-06-05T21%3A59%3A48Z&sr=b&sp=r&sig=VsulIs3Vw8QappOaWIin6%2FqLJN5M99%2FATZiOWFF3k0U%3D

This might be useful: https://github.com/MicrosoftDocs/PowerShell-Docs/issues/5665

Then I found this. But there is no doc in here related to my issue.

Yes on the main page -- Click on the Green Code Button, then click Download Zip. It will work better if you have a copy of the GitHub desktop client, but its not technically necessary.

Sorry to break it to you, but Preheat is not an approved Powershell verb :(

This issue explains the reason. Get-Service was using DCOM, which has been removed.

This is a better looking version of what Java and C# have had for a long time (kudos to the author for that!), is that the inspiration for this tool?

https://docs.oracle.com/javase/8/docs/technotes/tools/window...

https://dotnet.github.io/docfx/

I saw the author mentioned in another comment that they found themselves peeping inside type declaration files "too often". While I do often use sites generated by the above tools to discover new API's that suit my needs, diving into the actual code using a good decompiler is still my first move, as it is often cheaper than seeking out the documentation online, and it will show me the actual implementation as well. So in my opinion there is no shame in looking inside the declaration files!

Tools like DocFx provide the ability to display the programmable functions in HTML pages. They are used with the following commands in the docfx folder:

AFAIK they use https://github.com/dotnet/docfx which can be too heavy for your case. We use mdBook for internal documentation (plain .md with mermaid plugin) and then serve it at docs.yourdevenv.com.

DocFX is a nice solution.

It uses DocFX

Some of the standard and well-maintained Tools for Comments are JSDoc for Javascript, DocFx for .NET, and JavaDoc for Java.

Actually, we use it for OptiTune, it's called "docfx" https://dotnet.github.io/docfx/

We would really prefer to use a somewhat generic pre-made tool for this (such as DocFX) compared to rolling our own solution. We can roll our own solution... But would prefer not to so that we can minimize development and maintenance overhead.