Skip to content

Commit 214c3f2

Browse files
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 (<Group>/<Group>.md or <Group>/index.md) as the section landing page instead of a nested page. Documented in README. Fixes #371.
1 parent 0d7a2f0 commit 214c3f2

2 files changed

Lines changed: 3 additions & 2 deletions

File tree

.github/workflows/Build-Docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
path: ${{ fromJson(inputs.Settings).WorkingDirectory }}/outputs/module
3131

3232
- name: Document module
33-
uses: PSModule/Document-PSModule@fb5d349fa6e6ff8277b2eaf32a588cd97b234525 # v1.0.17
33+
uses: PSModule/Document-PSModule@349090c346feca4a7e5f51b6e57278a13ad52657 # v1.0.18
3434
with:
3535
Name: ${{ fromJson(inputs.Settings).Name }}
3636
WorkingDirectory: ${{ fromJson(inputs.Settings).WorkingDirectory }}

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1072,6 +1072,7 @@ Key expectations:
10721072
- Keep at least one exported function under `src/functions/public/` and corresponding tests in `tests/`.
10731073
- Optional folders (`assemblies`, `formats`, `types`, `variables`, and others) are processed automatically when present.
10741074
- Markdown files in `src/functions/public` subfolders become documentation pages alongside generated help.
1075+
- A group's overview page (`<Category>/<Category>.md` named after the folder, or `<Category>/index.md`) becomes that group's section landing page in the docs navigation.
10751076
- The build step compiles `src/` into a root module file and removes the original project layout from the artifact.
10761077
- Documentation generation mirrors the `src/functions/public` hierarchy so help content always aligns with source.
10771078

@@ -1100,7 +1101,7 @@ How the module is built.
11001101
│ │ └── public/ # Public commands documented and tested
11011102
│ │ ├── Category/ # Optional: organize commands into categories
11021103
│ │ │ ├── Get-CategoryCommand.ps1 # Command file within category
1103-
│ │ │ └── Category.md # Category overview merged into docs output
1104+
│ │ │ └── Category.md # Group overview -> section landing page (or index.md)
11041105
│ │ ├── Get-PSModuleTest.ps1 # Example command captured by Microsoft.PowerShell.PlatyPS
11051106
│ │ ├── New-PSModuleTest.ps1 # Example command exported and tested
11061107
│ │ ├── Set-PSModuleTest.ps1 # Example command exported and tested

0 commit comments

Comments
 (0)