From 214c3f209459f6c9256a428cfb47167eb80d0e1b Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Thu, 9 Jul 2026 21:40:25 +0200 Subject: [PATCH] Bump Document-PSModule to v1.0.18; document group section index pages Build-Docs now uses Document-PSModule v1.0.18, which publishes a group's overview page (/.md or /index.md) as the section landing page instead of a nested page. Documented in README. Fixes #371. --- .github/workflows/Build-Docs.yml | 2 +- README.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/Build-Docs.yml b/.github/workflows/Build-Docs.yml index 9e19000f..5df14f06 100644 --- a/.github/workflows/Build-Docs.yml +++ b/.github/workflows/Build-Docs.yml @@ -30,7 +30,7 @@ jobs: path: ${{ fromJson(inputs.Settings).WorkingDirectory }}/outputs/module - name: Document module - uses: PSModule/Document-PSModule@fb5d349fa6e6ff8277b2eaf32a588cd97b234525 # v1.0.17 + uses: PSModule/Document-PSModule@349090c346feca4a7e5f51b6e57278a13ad52657 # v1.0.18 with: Name: ${{ fromJson(inputs.Settings).Name }} WorkingDirectory: ${{ fromJson(inputs.Settings).WorkingDirectory }} diff --git a/README.md b/README.md index 417ebe87..3e4500be 100644 --- a/README.md +++ b/README.md @@ -1072,6 +1072,7 @@ Key expectations: - Keep at least one exported function under `src/functions/public/` and corresponding tests in `tests/`. - Optional folders (`assemblies`, `formats`, `types`, `variables`, and others) are processed automatically when present. - Markdown files in `src/functions/public` subfolders become documentation pages alongside generated help. +- A group's overview page (`/.md` named after the folder, or `/index.md`) becomes that group's section landing page in the docs navigation. - The build step compiles `src/` into a root module file and removes the original project layout from the artifact. - Documentation generation mirrors the `src/functions/public` hierarchy so help content always aligns with source. @@ -1100,7 +1101,7 @@ How the module is built. │ │ └── public/ # Public commands documented and tested │ │ ├── Category/ # Optional: organize commands into categories │ │ │ ├── Get-CategoryCommand.ps1 # Command file within category -│ │ │ └── Category.md # Category overview merged into docs output +│ │ │ └── Category.md # Group overview -> section landing page (or index.md) │ │ ├── Get-PSModuleTest.ps1 # Example command captured by Microsoft.PowerShell.PlatyPS │ │ ├── New-PSModuleTest.ps1 # Example command exported and tested │ │ ├── Set-PSModuleTest.ps1 # Example command exported and tested