I like good Docs, and I cannot lie

on YouTube ↗41m

" summary

Shows how comment based help + a HelpUri in commandbinding becomes a clickable web page via get-help -Online, turns function comment blocks into validated markdown with PlatyPS, and builds a static site with make docs deployed to GitHub Pages from CI. Includes concrete steps: combine public functions into a psm1, run New-MarkdownHelp, host site or GH deploy, and Pester-test that help exists; CI needs a username + PAT embedded URL for unattended GH deploy.

AI-written summary · about

" chapters (10)

1. 0:00PowerShell documentation intro
2. 1:49Summit Docs module demo
3. 3:35Comment-based help matters
4. 7:48Help URI with Platypus
5. 10:36Markdown help with Platypus
6. 17:28MkDocs for static docs
7. 22:51Publish docs with GitHub Pages
8. 28:04CI pipelines automation
9. 34:11Dash online final demo
10. 38:45Platypus advanced features & Q&A

" related talks

• 01h 29mPlatyPS: PowerShell Help meets MarkdownSergei Vorobev · PowerShell + DevOps Global Summit 2018
• 01h 21mPublish PowerShell help content using PlatyPS v1.0Stephen Valdinger, Sean Wheeler · PowerShell + DevOps Global Summit 2026
• 01h 29mWhat's new in PlatyPSSean Wheeler · PowerShell + DevOps Global Summit 2025
• 51mWriting the Darn DocsRaymond Camden · Open Source 101 at Home 2020
• 36mBuilding Docs like Code: Continuous Integration for DocumentationMason Egger · PyCon Latam 2019
• 35mHelping Your Community Contribute to Developer DocumentationDiana Lakatos · Write the Docs Prague 2020
• 19mWhere Docs, Cloud-hosted Interactive Tutorials and CI Testing IntersectDan Gunter · Write the Docs Portland 2020
• 05mDocs as Part of the Product: Open Source Technical Documentation at ScaleDen Delimarschi · Open Source Summit North America 2018