Commit ea19a3e
authored
π©Ή [Patch]: Render group overview pages as section landing pages (#372)
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.
- Fixes #371
## 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
- `.github/workflows/Build-Docs.yml`: `Document-PSModule@fb5d349 #
v1.0.17` -> `@349090c # v1.0.18`.
- `main` already carries v1.0.17 (install built modules at their real
version) from #342; this PR advances the pin to v1.0.18, which delivers
the section-index behavior.
- The site config already enables `navigation.indexes`, so no
`mkdocs.yml` change is required.1 parent 0d7a2f0 commit ea19a3e
2 files changed
Lines changed: 3 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
33 | | - | |
| 33 | + | |
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1072 | 1072 | | |
1073 | 1073 | | |
1074 | 1074 | | |
| 1075 | + | |
1075 | 1076 | | |
1076 | 1077 | | |
1077 | 1078 | | |
| |||
1100 | 1101 | | |
1101 | 1102 | | |
1102 | 1103 | | |
1103 | | - | |
| 1104 | + | |
1104 | 1105 | | |
1105 | 1106 | | |
1106 | 1107 | | |
| |||
0 commit comments