Skip to content

Commit aa16e99

Browse files
📖 [Docs]: Use Process-PSModule in help guidance
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 8f35ce9 commit aa16e99

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The goal is a stable repository anatomy so both humans and automation know exact
4040
│ ├── PSModule.yml # Settings parsed to drive matrices
4141
│ └── release.yml # Release automation template invoked on publish
4242
├── examples/ # Samples referenced in generated documentation
43-
│ └── General.ps1 # Example script ingested by Document-PSModule
43+
│ └── General.ps1 # Example script processed by Process-PSModule
4444
├── icon/ # Icon assets linked from manifest and documentation
4545
│ └── icon.png # Default module icon (PNG format)
4646
├── src/ # Module source, see "Module source code structure" below
@@ -72,9 +72,9 @@ Key expectations:
7272

7373
### Grouping and published help URLs
7474

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>/`.
75+
Process-PSModule generates command help and publishes 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>/`.
7676

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.
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. Process-PSModule does not create redirects for the old path; arrange a redirect separately in the publishing layer when existing links must continue to work.
7878

7979
## Module source code structure
8080

@@ -125,7 +125,7 @@ How the module is built.
125125
│ ├── finally.ps1 # Cleanup script appended to the root module
126126
│ ├── header.ps1 # Optional header injected at the top of the module
127127
│ ├── manifest.psd1 (optional) # Source manifest reused when present
128-
│ └── README.md # Module-level docs ingested by Document-PSModule
128+
│ └── README.md # Module-level docs processed by Process-PSModule
129129
```
130130

131131
### Declaring module dependencies

0 commit comments

Comments
 (0)