Skip to content

Commit 329b5f5

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 54e2677 commit 329b5f5

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@dc5b329f840f7803ec02d34a42ee725bca39db5f # v1.0.16
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
@@ -1065,6 +1065,7 @@ Key expectations:
10651065
- Keep at least one exported function under `src/functions/public/` and corresponding tests in `tests/`.
10661066
- Optional folders (`assemblies`, `formats`, `types`, `variables`, and others) are processed automatically when present.
10671067
- Markdown files in `src/functions/public` subfolders become documentation pages alongside generated help.
1068+
- 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.
10681069
- The build step compiles `src/` into a root module file and removes the original project layout from the artifact.
10691070
- Documentation generation mirrors the `src/functions/public` hierarchy so help content always aligns with source.
10701071

@@ -1093,7 +1094,7 @@ How the module is built.
10931094
│ │ └── public/ # Public commands documented and tested
10941095
│ │ ├── Category/ # Optional: organize commands into categories
10951096
│ │ │ ├── Get-CategoryCommand.ps1 # Command file within category
1096-
│ │ │ └── Category.md # Category overview merged into docs output
1097+
│ │ │ └── Category.md # Group overview -> section landing page (or index.md)
10971098
│ │ ├── Get-PSModuleTest.ps1 # Example command captured by Microsoft.PowerShell.PlatyPS
10981099
│ │ ├── New-PSModuleTest.ps1 # Example command exported and tested
10991100
│ │ ├── Set-PSModuleTest.ps1 # Example command exported and tested

0 commit comments

Comments
 (0)