Commit ab2632b
authored
⚙️ [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.
- 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.1 parent 6a2826f commit ab2632b
6 files changed
Lines changed: 59 additions & 9 deletions
File tree
- .github/workflows
- src/functions/public
- IndexSection
- NamedSection
- tests
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
30 | | - | |
| 30 | + | |
31 | 31 | | |
32 | 32 | | |
33 | | - | |
34 | | - | |
35 | | - | |
36 | | - | |
37 | | - | |
38 | | - | |
39 | | - | |
40 | | - | |
41 | 33 | | |
42 | 34 | | |
43 | 35 | | |
Lines changed: 21 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
Lines changed: 21 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
25 | 31 | | |
0 commit comments