Uh oh!
There was an error while loading. Please reload this page.
🩹 [Patch]: Render group overview pages as section landing pages - #372
Merged
Marius Storhaug (MariusStorhaug) merged 1 commit intoJul 10, 2026
Merged
Conversation
Copilotstarted reviewing on behalf of Marius Storhaug (MariusStorhaug)July 9, 2026 19:40 View session
Contributor
There was a problem hiding this comment.
Pull request overview
Updates this repository’s docs build pipeline to use PSModule/Document-PSModule v1.0.18, enabling command-group overview markdown (<Group>/<Group>.md or <Group>/index.md) to render as the group’s section landing page (MkDocs section index) rather than as a nested page. The README is updated to document the new behavior and recommended module source structure expectations.
Changes:
- Bump
PSModule/Document-PSModuleGitHub Action from v1.0.16 to v1.0.18 in the docs workflow. - Document that
<Category>/<Category>.md(or<Category>/index.md) becomes the section landing page in the generated docs. - Update the module source-structure tree annotation to reflect the new landing-page behavior.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Documents the new “group overview as section landing page” behavior and updates the source-structure guidance accordingly. |
| .github/workflows/Build-Docs.yml | Updates the pinned PSModule/Document-PSModule action SHA to v1.0.18 to deliver the new rendering behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
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.
Marius Storhaug (MariusStorhaug)force-pushed
the
maintenance/document-psmodule-index-pages
branch
from
July 9, 2026 21:11
329b5f5 to
214c3f2CompareCopilotstarted reviewing on behalf of Marius Storhaug (MariusStorhaug)July 9, 2026 21:12 View session
Uh oh!
There was an error while loading. Please reload this page.
Copilotstarted reviewing on behalf of Marius Storhaug (MariusStorhaug)July 9, 2026 22:17 View session
Uh oh!
There was an error while loading. Please reload this page.
Marius Storhaug (MariusStorhaug)
deleted the
maintenance/document-psmodule-index-pages
branch
July 10, 2026 07:36
Marius Storhaug (MariusStorhaug) added a commit
to PSModule/Template-PSModule
that referenced
this pull request
Jul 11, 2026
… (index.md + folder-named) (#27) Two example command groups demonstrate both supported ways to give a command group its documentation section landing page. `IndexSection` provides its landing page as `index.md`; `NamedSection` provides its landing page as a file named after the folder (`NamedSection.md`). Document-PSModule renders either overview page as the group's section landing page, so each group appears at `Functions/<Group>/` in the navigation of the published GitHub Pages site. - Demonstrates PSModule/Process-PSModule#372 (group overview pages become section landing pages) - Adopts PSModule/Process-PSModule#377 (caller-provided TestData reaches module tests in consumer repositories) ## New: Two command groups showcasing both landing-page conventions - `IndexSection/` — landing page from `index.md`, with `Get-IndexSectionTest`. - `NamedSection/` — landing page from the folder-named `NamedSection.md`, with `Get-NamedSectionTest`. Each renders as its group's section landing page (`Functions/IndexSection/` and `Functions/NamedSection/`) in the docs navigation. ## Technical Details - Adds `src/functions/public/IndexSection/{index.md, Get-IndexSectionTest.ps1}` and `src/functions/public/NamedSection/{NamedSection.md, Get-NamedSectionTest.ps1}`; both functions mirror the existing `*-PSModuleTest` shape and return `Hello, <Name>!`. - Adds `It` blocks for `Get-IndexSectionTest` and `Get-NamedSectionTest` in `tests/PSModuleTest.Tests.ps1`. - Generated docs place each group overview at `<Group>/index.md`; the rendered site exposes `Functions/IndexSection/index.html` and `Functions/NamedSection/index.html`. - Bumps the Process-PSModule pin (`v6.1.1` → `v6.1.2`) to adopt the fix that exposes caller-provided `TestData` to the module test jobs, keeping the module test matrix green.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Module documentation now renders a command group's overview page as that group's section landing page — the content shown when the group is selected in the navigation — instead of a separate page nested under it. This is delivered by bumping the
Document-PSModuleaction, and the behavior is documented in the repository and module-source structure guidance.Changed: Group overview pages are the section landing page
Bumped
PSModule/Document-PSModuleto v1.0.18 inBuild-Docs.yml. v1.0.18 publishes a group's overview page as the section index (/Functions/<Group>/) rather than a page nested under the group. Authors can name the overview after its folder (<Category>/<Category>.md) or provide<Category>/index.mddirectly; either becomes the section landing page.Changed: Documentation
Documented the behavior in
README.md: added a bullet under the repository expectations and updated theCategory.mdannotation in the module source-structure tree.Technical Details
.github/workflows/Build-Docs.yml:Document-PSModule@fb5d349 # v1.0.17->@349090c # v1.0.18.mainalready carries v1.0.17 (install built modules at their real version) from 🚀 [Feature]: Plan job decides version before build so tested artifact equals published artifact #342; this PR advances the pin to v1.0.18, which delivers the section-index behavior.navigation.indexes, so nomkdocs.ymlchange is required.