Skip to content

0.0.9

Latest

Choose a tag to compare

@github-actions github-actions released this 11 Jul 12:32
ab2632b

⚙️ [Maintenance]: Showcase both docs section landing-page conventions (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.

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.1v6.1.2) to adopt the fix that exposes caller-provided TestData to the module test jobs, keeping the module test matrix green.