[Feature] Offline PSADT Documentation

[codylc]

Summary of the new feature / enhancement

As someone who leverages LLMs in my development, I’d like an offline copy of PSADT documentation so that I can quickly train up an agent on PSADT functions and code syntax to produce accurate, version-specific code.

Proposed technical implementation details (optional)

It would be excellent if the documentation were available in markdown (a single file would be preferred) or a PDF that we could feed to an LLM before automating script development. Whatever method makes this easiest for the team to maintain while preventing me from copying and pasting dozens of webpages into the LLM.

[DanGough]

There are no immediate plans to offer this, but there are certainly a more elegant solutions at your disposal thant copying and pasting webpages.

You could just use the native help commands and pipe the output to a single file, e.g:

Get-Command -Module PSAppDeployToolkit | ForEach-Object {Get-Help -Name $_.Name -Full} | Out-File -FilePath C:\Temp\Help\PSAppDeployToolkit.txt -Force

Or you could try using the latest version of the PlatyPS module (we're using an older version in the module build process as it fits in better with our Docusaurus export, but for your purposes I'd play with the latest supported version):
https://learn.microsoft.com/en-gb/powershell/utility-modules/platyps/step-1-create-new-markdown-help?view=ps-modules

Import-Module PSAppDeployToolkit
Import-Module Microsoft.PowerShell.PlatyPS
New-MarkdownCommandHelp -ModuleInfo (Get-Module -Name 'PSAppDeployToolkit') -OutputFolder 'C:\Temp\Help' -Force

You will want to play with trimming that output down so that you can keep your LLM context lean. If you come up with a good solution for this that you think might help others, by all means please share back here!

In fact this would be a good candidate for the PSAppDeployToolkit.Tools module - it wouldn't be part of the website repo, and having it separate from the main module would make it easier to be able to generate a markdown file for any version of the module. I'll transfer it.