Skip to content

🩹 [Patch]: Render group overview pages as section landing pages #372

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Marius Storhaug (MariusStorhaug) merged 1 commit into from
Jul 10, 2026
+3 −2
Merged

🩹 [Patch]: Render group overview pages as section landing pages #372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/Build-Docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Comment thread
MariusStorhaug marked this conversation as resolved.
with:
Name: ${{ fromJson(inputs.Settings).Name }}
WorkingDirectory: ${{ fromJson(inputs.Settings).WorkingDirectory }}
Expand Down
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 (`<Category>/<Category>.md` named after the folder, or `<Category>/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.

Expand Down Expand Up @@ -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
Expand Down
Loading