Commit d4b270c
📖 [Docs]: Module layout guidance now covers grouped help URLs (#453)
Module authors now see how grouping public commands changes their
published help URLs and which links must move with the command. This
keeps canonical links, private-helper references, and regrouping
migrations aligned with the module layout.
## New: Grouped command help URL guidance
The module-structuring guide now explains the canonical URL for a
grouped public command, requires that URL to be the first public
`.LINK`, and shows private helpers where to link. It also explains that
moving a command changes its published path, so authors should update
references in the same change and arrange redirects separately when
existing links must continue to work.
---
<details>
<summary>Technical details</summary>
- Changed surface: `docs/content/guides/structuring-your-module.md`
(Markdown guidance).
- Added the grouped URL form with the trailing slash, the first-link
convention, private-helper link guidance, and regrouping migration
implications.
- Verified the URL pattern against
`.github/actions/Test-PSModule/src/tests/SourceCode/PSModule/PSModule.Tests.ps1`
and the documentation path handling in
`.github/actions/Document-PSModule/src/helpers/Build-PSModuleDocumentation.ps1`.
- Validation: `zensical build --strict` passed; the existing Pester
6.1.0 source-code suite passed all 13 tests with the grouped command
fixtures.
- Implementation plan progress: completes the documentation intent from
PSModule/docs#105 and the scope of #485.
| Changed surface | Standards checked | Framework docs checked | Result
|
| --- | --- | --- | --- |
| `docs/content/guides/structuring-your-module.md` | MSX Documentation
Model, Markdown | Module source layout and canonical public help-link
behavior | Aligned |
Issue convergence sweep: scoped to open Process-PSModule issues
concerning grouped module layout and canonical help links.
#485 is fully satisfied by this change;
#445 remains broader follow-up work because it
concerns generating links during scaffolding/build.
</details>
<details>
<summary>Relevant issues (or links)</summary>
- Resolves #485
### Related work
- References PSModule/docs#105
- References #445
</details>
---------
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>1 parent 09fc45f commit d4b270c
1 file changed
Lines changed: 10 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
43 | | - | |
| 43 | + | |
44 | 44 | | |
45 | 45 | | |
46 | 46 | | |
| |||
67 | 67 | | |
68 | 68 | | |
69 | 69 | | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
70 | 78 | | |
71 | 79 | | |
72 | 80 | | |
| |||
117 | 125 | | |
118 | 126 | | |
119 | 127 | | |
120 | | - | |
| 128 | + | |
121 | 129 | | |
122 | 130 | | |
123 | 131 | | |
| |||
0 commit comments