Skip to content

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

Merged
Marius Storhaug (MariusStorhaug) merged 1 commit into
mainfrom
maintenance/document-psmodule-index-pages
Jul 10, 2026
Merged

🩹 [Patch]: Render group overview pages as section landing pages#372
Marius Storhaug (MariusStorhaug) merged 1 commit into
mainfrom
maintenance/document-psmodule-index-pages

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Jul 9, 2026

Copy link
Copy Markdown
Member

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-PSModule action, 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-PSModule to v1.0.18 in Build-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.md directly; either becomes the section landing page.

Changed: Documentation

Documented the behavior in README.md: added a bullet under the repository expectations and updated the Category.md annotation in the module source-structure tree.

Technical Details

@MariusStorhaug Marius Storhaug (MariusStorhaug) requested a review from a team as a code owner July 9, 2026 19:40
Copilot AI review requested due to automatic review settings July 9, 2026 19:40
@MariusStorhaug Marius Storhaug (MariusStorhaug) added documentation Improvements or additions to documentation Patch dependencies Pull requests that update a dependency file labels Jul 9, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-PSModule GitHub 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.

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

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.
Copilot AI review requested due to automatic review settings July 9, 2026 21:11
@MariusStorhaug Marius Storhaug (MariusStorhaug) force-pushed the maintenance/document-psmodule-index-pages branch from 329b5f5 to 214c3f2 Compare July 9, 2026 21:11

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comment thread .github/workflows/Build-Docs.yml
@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title 🩹 [Patch]: Render group overview pages as section landing pages (Document-PSModule v1.0.18) 🩹 [Patch]: Render group overview pages as section landing pages Jul 9, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@MariusStorhaug Marius Storhaug (MariusStorhaug) merged commit ea19a3e into main Jul 10, 2026
70 checks passed
@MariusStorhaug Marius Storhaug (MariusStorhaug) deleted the maintenance/document-psmodule-index-pages branch July 10, 2026 07:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation Patch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Publish group overview pages as the section index instead of a nested sub-page

2 participants