Skip to content

Commit 8f35ce9

Browse files
📖 [Docs]: Document grouped public command help URLs
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 120554a commit 8f35ce9

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

docs/content/guides/structuring-your-module.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,14 @@ Key expectations:
6767
- A group's overview page (`<Category>/<Category>.md` named after the folder, or `<Category>/index.md`) becomes that group's section landing page in the docs navigation.
6868
- The build step compiles `src/` into a root module file and removes the original project layout from the artifact.
6969
- Documentation generation mirrors the `src/functions/public` hierarchy so help content always aligns with source.
70+
- Put the canonical public help URL first in each public command's comment-based help. For a command at `src/functions/public/<Group>/<Name>.ps1`, use `https://psmodule.io/<ModuleName>/Functions/<Group>/<Name>/`. `Test-PSModule` enforces this as `PublicHelpLink`; additional `.LINK` entries may follow.
71+
- Point each private helper's `.LINK` entry to the public command it supports, using that command's canonical grouped URL.
72+
73+
### Grouping and published help URLs
74+
75+
`Document-PSModule` generates command help and then moves each page to mirror the relative path under `src/functions/public/`. Moving an existing command into a group therefore changes its published URL from `https://psmodule.io/<ModuleName>/Functions/<Name>/` to `https://psmodule.io/<ModuleName>/Functions/<Group>/<Name>/`.
76+
77+
When regrouping a command, update its first public `.LINK`, every private-helper `.LINK` that points to it, and any other references to the old URL in the same change. `Document-PSModule` does not create redirects for the old path; arrange a redirect separately in the publishing layer when existing links must continue to work.
7078

7179
## Module source code structure
7280

0 commit comments

Comments
 (0)