Skip to content

📖 [Docs]: Documentation links in the template resolve again - #42

Draft
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
mainfrom
fix-repository-standard-link
Draft

📖 [Docs]: Documentation links in the template resolve again#42
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
mainfrom
fix-repository-standard-link

Conversation

@MariusStorhaug

Copy link
Copy Markdown
Member

Every documentation link in this template now resolves. Three links in README.md, AGENTS.md, and CONTRIBUTING.md pointed at a PSModule docs page that has been renamed, and a fourth pointed at an MSX page that moved — so a maintainer or agent following the guidance chain from a new module repository 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, so the reference reads the same way the destination is titled.

This matters beyond this repository: README.md, AGENTS.md, and CONTRIBUTING.md are copied into every module repository created from this template, so the broken link was being propagated with each new module.

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.io directly instead of psmodule.github.io, which only reaches the site through a redirect. Nothing changes about where a reader ends up — the links simply state the canonical host, which is what site_url in PSModule/docs declares.


Technical details

How the broken links were found. PSModule/docs#106 established that the documentation site had not been republished since 2026-07-18, which is why the renamed page still appeared to work: the old URL kept serving a stale build. Once PSModule/docs#107 restores publishing, the rename goes live and the old path starts returning 404. The referrer set was enumerated with gh search code "Repository-Defaults" --owner PSModule, which found eight files across four repositories; this pull request covers the three in this repository, and the rest are tracked on PSModule/docs#108.

Why the links were fixed rather than a redirect added. Recorded on PSModule/docs#108. In short: Zensical has no redirect support — zensical/backlog#23 is open — so a redirect would have to be a hand-written stub page that is built, search-indexed, excluded from navigation, and maintained indefinitely. The referrers are enumerable and in-organization, so correcting them is the smaller change.

Host handling, and why only the PSModule links changed. psmodule.github.io returns 301 to psmodule.io, and PSModule/docs declares site_url = "https://psmodule.io/docs/", so psmodule.io is unambiguously canonical and the links now say so. The MSX links were deliberately left on msxorg.github.io: that host also redirects, to msx.no, but MSXOrg/docs still declares site_url = "https://msxorg.github.io/...", so which host is canonical there is not settled and this pull request is not the place to decide it. Only the genuinely broken MSX path was corrected.

Verification. Every documentation URL in the changed files was requested; all return 200.

URL Status
https://psmodule.io/docs/Modules/Process-PSModule/template-quickstart/ 200
https://psmodule.io/docs/Modules/Process-PSModule/module-anatomy/ 200
https://psmodule.io/docs/Modules/Process-PSModule/build-test-pack-publish/ 200
https://psmodule.io/docs/Modules/Standards/ 200
https://msxorg.github.io/docs/Ways-of-Working/Issues/Process/Format/ 200
https://psmodule.io/docs/Modules/Repository-Standard/ 404 until PSModule/docs#107 merges, 200 after

The last row is the one dependency: this pull request should merge after PSModule/docs#107 restores publishing, or the link it introduces is briefly the broken one.

Standards and framework alignment.

Changed surface Standards checked Framework docs checked Result
README.md, AGENTS.md, CONTRIBUTING.md Markdown, Documentation — link-only changes, structure untouched Repository standard — the three files remain present and unchanged in purpose Aligned

Issue convergence sweep. Scope: open issues in this repository and in PSModule/docs concerning the template's community files or documentation links. Nothing in this repository is fully satisfied by this diff. PSModule/docs#108 is only partially satisfied — the already-propagated copies in PSSemVer and Lovdata remain — so it is linked without a closing keyword. PSModule/docs#63, on distributing these files, is untouched and remains the durable answer to this class of drift.

Relevant issues (or links)

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@github-actions

github-actions Bot commented Aug 2, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates documentation hyperlinks in the template’s community and guidance files so they resolve to the current PSModule/MSXOrg documentation URLs, preventing new module repositories created from this template from inheriting broken links.

Changes:

  • Updated PSModule documentation links to use the canonical https://psmodule.io/docs/... host.
  • Replaced the renamed PSModule page link (Repository-DefaultsRepository-Standard) and adjusted link text accordingly.
  • Updated the MSXOrg “issue format” link to the new path under Ways-of-Working/Issues/Process/Format/.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
README.md Updates the quickstart and repository checklist documentation links to the current PSModule docs URLs.
CONTRIBUTING.md Updates repository standard, issue format, and PSModule standards links to their current destinations.
AGENTS.md Updates the PSModule guidance chain links to the current PSModule docs host and page names.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants