Skip to content

v1.0.18

Latest

Choose a tag to compare

@github-actions github-actions released this 09 Jul 19:35
349090c

🪲 [Fix]: Group overview pages now render as the section landing page (#53)

When a command group has an overview page, it now becomes the landing page for that group in the generated documentation — the content shown when the group is selected in the navigation. Previously the overview was published as a separate page nested under the group (for example .../Functions/Auth/Auth/), so selecting the group only expanded it and the overview was easy to miss.

Fixed: Group overview pages are the section landing page

Give a command group an overview page and it now renders as that group's index on the docs site (/Functions/<Group>/). You can author it either way:

  • src/functions/public/<Group>/<Group>.md — named after the folder (the convention Template-PSModule ships). It is published as the group's index.md.
  • src/functions/public/<Group>/index.md — published as-is.

For example, src/functions/public/Auth/Auth.md (or Auth/index.md) now serves the Auth group's landing page at /Functions/Auth/ instead of /Functions/Auth/Auth/.

Existing modules that already use the <Group>/<Group>.md convention (such as Template-PSModule and the GitHub module's Auth group) get the corrected behavior automatically — no source changes required. Nested groups work too (Auth/Context/Context.md/Functions/Auth/Context/), and other hand-authored pages (e.g. PSModule/Notes.md) continue to publish as regular pages. If a folder somehow contains both a <Group>.md and an index.md, the explicit index.md is kept.

Technical Details

  • src/helpers/Build-PSModuleDocumentation.ps1 — in the "Move markdown files from public functions folder to docs output folder" step, a group overview whose basename matches its parent folder is written to <Group>/index.md; an existing index.md is published unchanged. Folders that already contain an index.md are collected before the move loop, so a sibling <Group>.md is never moved over an author-provided index.md (order-independent).
  • .github/workflows/Action-Test.yml — added a step asserting the fixture group overviews publish as index.md (PSModule via the folder-name path, SomethingElse via the explicit index.md path) and no longer as <Group>.md.
  • tests/srcTestRepo/src/functions/public/SomethingElse/SomethingElse.md renamed to index.md to cover the explicit-index.md path.
  • Relies on navigation.indexes, already enabled in the module mkdocs.yml template, for the section header to link to the index page.