Skip to content

Commit 64ffb1d

Browse files
📖 [Docs]: Process documentation links corrected (#539)
Process-PSModule documentation, site metadata, and agent guidance now direct users to the canonical `https://psmodule.io/Process-PSModule/` Pages site instead of retired documentation routes. ## Changed: Documentation destination All tracked references to `https://psmodule.io/docs` and `https://psmodule.github.io/docs` now use the Process-PSModule Pages root. Former deep documentation routes use the root because they have no guaranteed replacement. ## Adopting this release No configuration, code, or invocation changes are required beyond selecting this release. ## Release impact | Field | Decision | | --- | --- | | Effective decision | `release:skip` label for a documentation-only change. | | Semantic effect | No release. | | Release/base coordinates | No version is produced. | --- <details> <summary>Technical details</summary> ### Consumer change record | Identifier / surface | Before | After | Applicability / prerequisites | Consumer action | Verification | | --- | --- | --- | --- | --- | --- | | Documentation links | Retired `psmodule.io/docs` and `psmodule.github.io/docs` routes | `https://psmodule.io/Process-PSModule/` | All documentation consumers | Use the canonical Pages URL | Confirmed stale tracked URLs are absent and all nine replacements use the canonical root. | ### Template baseline No repository pull request template applies. ### Maintainer evidence Updated the nine tracked retired documentation references in five documentation and configuration files. The change is limited to link destinations. </details> <details> <summary>Relevant issues (or links)</summary> No related issues. ### Related work None. </details>
1 parent 105e4dc commit 64ffb1d

5 files changed

Lines changed: 9 additions & 9 deletions

File tree

.github/plugin/psmodule/plugin.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"name": "PSModule",
88
"url": "https://github.com/PSModule"
99
},
10-
"homepage": "https://psmodule.io/docs/",
10+
"homepage": "https://psmodule.io/Process-PSModule/",
1111
"repository": "https://github.com/PSModule/Process-PSModule",
1212
"license": "MIT",
1313
"keywords": [

AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ If you find a problem or improvement, fix if small; otherwise open an issue.
1515
Regarding repo structure, module source code, and how the Process-PSModule workflow
1616
works. For PSModule-specific build, layout, and process guidance:
1717

18-
- [Process-PSModule docs](https://psmodule.io/docs/)
18+
- [Process-PSModule docs](https://psmodule.io/Process-PSModule/)
1919
repository structure, module anatomy, and the build/test/pack/publish pipeline.
20-
- [Repository defaults](https://psmodule.github.io/docs/Modules/Repository-Defaults/)
20+
- [Repository defaults](https://psmodule.io/Process-PSModule/)
2121
the expected repository layout and required files.
22-
- [Standards](https://psmodule.github.io/docs/Modules/Standards/) — PowerShell module
22+
- [Standards](https://psmodule.io/Process-PSModule/) — PowerShell module
2323
coding standards.
2424
- [PSModule/memory](https://github.com/PSModule/memory) — durable cross-session agent
2525
working memory for the PSModule organization.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ Documentation site generation is powered by Zensical. Repositories define site c
88

99
The full documentation is published at:
1010

11-
📖 **[Process-PSModule documentation](https://psmodule.io/docs/)**
11+
📖 **[Process-PSModule documentation](https://psmodule.io/Process-PSModule/)**
1212

1313
It covers getting started, the pipeline stages, usage, configuration, repository structure, and the principles behind the framework.

docs/content/reference/repository-standard.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Module repositories use the PSModule framework layout:
8484
| `SECURITY.md` | Security support policy and private vulnerability reporting instructions. |
8585
| `SUPPORT.md` | Support expectations and where users ask for help. |
8686
| `CODE_OF_CONDUCT.md` | Community conduct expectations. |
87-
| `AGENTS.md` | Agent onboarding entry point. Points agents to the canonical guidance at `https://psmodule.io/docs/`. |
87+
| `AGENTS.md` | Agent onboarding entry point. Points agents to the canonical guidance at `https://psmodule.io/Process-PSModule/`. |
8888
| `CLAUDE.md` | Claude Code entry point. Imports `AGENTS.md` so Claude reads the same instructions. |
8989
| `.github/PSModule.yml` | Module workflow configuration overrides. |
9090
| `.github/workflows/Process-PSModule.yml` | Caller workflow that runs the module's CI/CD by calling the shared Process-PSModule workflow. |
@@ -151,7 +151,7 @@ Required baseline files for module repositories:
151151
| `SECURITY.md` | Private vulnerability reporting and latest-version support policy. |
152152
| `SUPPORT.md` | Support channel and issue-routing expectations. |
153153
| `CODE_OF_CONDUCT.md` | Community participation rules. |
154-
| `AGENTS.md` | Cross-tool agent instructions pointing to the canonical guidance at `https://psmodule.io/docs/`. |
154+
| `AGENTS.md` | Cross-tool agent instructions pointing to the canonical guidance at `https://psmodule.io/Process-PSModule/`. |
155155
| `CLAUDE.md` | Claude Code entry point that imports `AGENTS.md`. |
156156
| `.github/dependabot.yml` | Configures ecosystem-appropriate dependency-update pull requests. For PowerShell module repositories the `github-actions` ecosystem is expected; add any other ecosystems the module actually develops in. |
157157
| `.github/CODEOWNERS` | Review routing for source, docs, and GitHub workflow files. |
@@ -168,7 +168,7 @@ Each repository must stand on its own. It carries its own copy of every file abo
168168

169169
Every repository must be usable by an agent that has never seen it before, without special configuration. Each repository carries its own agent entry points that point to the authoritative documentation instead of restating it:
170170

171-
- `AGENTS.md`: the cross-tool entry point, read by the GitHub Copilot coding agent, VS Code, and other AGENTS.md-aware tools. It names what the repository is in a line or two and points to the canonical agent guidance at [psmodule.io/docs](https://psmodule.io/docs/).
171+
- `AGENTS.md`: the cross-tool entry point, read by the GitHub Copilot coding agent, VS Code, and other AGENTS.md-aware tools. It names what the repository is in a line or two and points to the canonical agent guidance at [psmodule.io/Process-PSModule](https://psmodule.io/Process-PSModule/).
172172
- `CLAUDE.md`: a thin file that imports `AGENTS.md` with `@AGENTS.md` so Claude Code reads the same instructions. Claude-specific notes, if any, go below the import.
173173

174174
See [PSModule/Template-PSModule](https://github.com/PSModule/Template-PSModule) for a concrete implementation example of `AGENTS.md` and `CLAUDE.md`.

docs/zensical.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
[project]
55
site_name = "PSModule / Docs"
6-
site_url = "https://psmodule.io/docs/"
6+
site_url = "https://psmodule.io/Process-PSModule/"
77
docs_dir = "content"
88
repo_name = "PSModule/Process-PSModule"
99
repo_url = "https://github.com/PSModule/Process-PSModule"

0 commit comments

Comments
 (0)