📖 [Docs]: Documentation links in the community files resolve again - #22
📖 [Docs]: Documentation links in the community files resolve again#22Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
The failing Cause.
Every pull request targeting Already fixed upstream. PSModule/Process-PSModule#432, "Version resolution no longer fails on repositories without releases", merged 2026-08-02 and shipped in v6.1.15. Runs on the newer pin log Why What this needs. Nothing here. Once #3 merges and Ruled out along the way: labels. The first failure had none, so the obvious suspect was the release-label lookup. Adding |
There was a problem hiding this comment.
🟢 Ready to approve
The changes are limited to documentation link updates, and the resulting Markdown structure and URLs are consistent and internally coherent.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
This PR updates documentation URLs in the repository’s community-facing Markdown files so they don’t lead to renamed/moved pages and so PSModule documentation links use the canonical psmodule.io host.
Changes:
- Updated PSModule doc links from
psmodule.github.ioto the canonicalhttps://psmodule.io/docs/.... - Replaced the renamed “repository defaults” link with “repository standard” (
/Modules/Repository-Standard/). - Updated the MSXOrg “issue format” link to its current path (
/Ways-of-Working/Issues/Process/Format/).
File summaries
| File | Description |
|---|---|
| README.md | Updates PSModule quickstart and repository checklist links to canonical/renamed targets. |
| CONTRIBUTING.md | Updates repository standard, issue format, and PSModule standards links to current/canonical targets. |
| AGENTS.md | Updates the PSModule guidance-chain links to canonical host and renamed “Repository standard” page. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 0
- Review effort level: Lite
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
Documentation links in this repository's community files now resolve. Two PSModule docs pages they pointed at have been renamed or moved, so a maintainer or agent following the guidance chain landed on a 404 instead of the page they were sent to.
Fixed: the repository standard link resolves
The "repository defaults" link now points at Repository standard, which is where that page lives after it was renamed in PSModule/docs#96. The link text follows the page's new name.
Fixed: the issue format link resolves
The "issue format" link pointed at
Ways-of-Working/Issue-Format/, which no longer exists. It now points at Issues / Process / Format, the page that replaced it.Changed: PSModule documentation links use the canonical host
PSModule documentation links now use
psmodule.iodirectly instead ofpsmodule.github.io, which only reaches the site through a redirect. Readers end up in the same place; the links now simply state the canonical host.Technical details
Why these files drifted.
AGENTS.md,CONTRIBUTING.md, andREADME.mdoriginate inPSModule/Template-PSModuleand were copied here when this repository was created. When the destination page was renamed, the copies were not updated, and nothing checks them. The same correction is applied at the source in PSModule/Template-PSModule#42 so new repositories start correct; this pull request fixes the copy that already shipped. PSModule/docs#63 tracks distributing these files, which is the durable answer to this class of drift.How it was found. PSModule/docs#106 established that the documentation site had not been republished since 2026-07-18, which is why the old URL still appeared to work — it was serving a stale build. Once PSModule/docs#107 restores publishing, the rename goes live and the old path starts returning 404. Referrers were enumerated with
gh search code "Repository-Defaults" --owner PSModule; the full set is recorded on PSModule/docs#108.Host handling.
psmodule.github.ioreturns301topsmodule.io, andPSModule/docsdeclaressite_url = "https://psmodule.io/docs/", sopsmodule.iois canonical and the links now say so. The MSX links were deliberately left onmsxorg.github.io: that host also redirects, tomsx.no, butMSXOrg/docsstill declaressite_url = "https://msxorg.github.io/...", so which host is canonical there is unsettled and this pull request does not decide it. Only the genuinely broken MSX path was corrected.Verification. Every documentation URL in the changed files was requested; all return
200, excepthttps://psmodule.io/docs/Modules/Repository-Standard/, which returns404until PSModule/docs#107 restores publishing and200after. This pull request should therefore merge after that one.Standards and framework alignment.
AGENTS.md,CONTRIBUTING.md,README.mdIssue convergence sweep. Scope: open issues in this repository and in
PSModule/docsconcerning documentation links or the community files. Nothing in this repository is fully satisfied by this diff. PSModule/docs#108 is only partially satisfied — it also covers the template and the other propagated copies — so it is linked without a closing keyword.Relevant issues (or links)