Skip to content

📖 [Docs]: Documentation links in the community files resolve again - #53

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

📖 [Docs]: Documentation links in the community files resolve again#53
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
mainfrom
fix-repository-standard-link

Conversation

@MariusStorhaug

Copy link
Copy Markdown
Member

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.io directly instead of psmodule.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, and README.md originate in PSModule/Template-PSModule and 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/Process-PSModule#478 tracks distributing these files, which is the durable answer to this class of drift.

How it was found.PSModule/Process-PSModule#486 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/Process-PSModule#487.

Host handling.psmodule.github.io returns 301 to psmodule.io, and PSModule/docs declares site_url = "https://psmodule.io/docs/", so psmodule.io is 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 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, except https://psmodule.io/docs/Modules/Repository-Standard/, which returns 404 until PSModule/docs#107 restores publishing and 200 after. This pull request should therefore merge after that one.

Standards and framework alignment.

Changed surfaceStandards checkedFramework docs checkedResult
AGENTS.md, CONTRIBUTING.md, README.mdMarkdown, Documentation — link-only changes, structure untouchedRepository standard — the files remain present and unchanged in purposeAligned

Issue convergence sweep. Scope: open issues in this repository and in PSModule/docs concerning documentation links or the community files. Nothing in this repository is fully satisfied by this diff. PSModule/Process-PSModule#487 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)

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

Copy link
Copy Markdown

No Significant Changes Detected

This PR does not contain changes to files that would trigger a new release:

PatternDescription
^src/Matches files where path matches this pattern
^README\.md$Matches files where path matches this pattern

Build, test, and publish stages will be skipped for this PR.

If you believe this is incorrect, please verify that your changes are in the correct locations.

@github-actions

Copy link
Copy Markdown

Super-linter summary

LanguageValidation result
CHECKOVPass ✅
GITHUB_ACTIONSPass ✅
GITLEAKSPass ✅
GIT_MERGE_CONFLICT_MARKERSPass ✅
MARKDOWNPass ✅
NATURAL_LANGUAGEPass ✅
POWERSHELLPass ✅
PRE_COMMITPass ✅
SPELL_CODESPELLPass ✅
TRIVYPass ✅
YAMLPass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

CopilotAI 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 URLs in this repository’s community guidance files so that referenced PSModule/MSXOrg documentation pages resolve again (reflecting moved/renamed pages and canonical hosts).

Changes:

  • Update “Repository defaults” references to the renamed “Repository standard” page and adjust link text accordingly.
  • Fix the MSXOrg “issue format” link to the new replacement path.
  • Switch PSModule documentation links from psmodule.github.io to the canonical psmodule.io host.

Reviewed changes

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

FileDescription
AGENTS.mdUpdates PSModule guidance links to psmodule.io and renames “Repository defaults” → “Repository standard”.
CONTRIBUTING.mdFixes “repository standard”, “issue format”, and PSModule Standards links so they resolve and use canonical hosts.

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

Sign up for freeto 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

@MariusStorhaug