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/Process-PSModule#486 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/Process-PSModule#487.

Why the links were fixed rather than a redirect added. Recorded on PSModule/Process-PSModule#487. 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/Process-PSModule#487 is only partially satisfied — the already-propagated copies in PSSemVer and Lovdata remain — so it is linked without a closing keyword. PSModule/Process-PSModule#478, 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.

Marius Storhaug (MariusStorhaug) added a commit that referenced this pull request Sep 5, 2026
New modules created from this template start with the current
Process-PSModule v8 test and documentation contract, a repository-local
contribution guide, and centrally managed PSModule community policies.
The template's scheduled framework run returns to green.

## Fixed: Current Process-PSModule compatibility

The starter test requires Pester 6.1.0 while retaining the supported 6.x
range. The starter public function links first to its generated online
reference, as required by the framework source test.

## Changed: Generated documentation design

Generated module sites now share the portable typography, icons,
palettes, navigation, search, content, plugin, and Markdown-extension
settings from MSXOrg/docs. Explicit navigation remains absent, so
Zensical derives index-first, alphabetical navigation from the generated
folder tree. Cookie consent is not part of the generated-module
template.

## Changed: Repository and organization guidance have explicit owners

The repository owns `.github/CONTRIBUTING.md`. Code of Conduct,
security, and support policies remain centrally managed by
`PSModule/.github` and are linked rather than copied. Process-PSModule
owns module releases, so the template no longer carries unused GitHub
generated-release-notes configuration.

---
<details>
<summary>Technical details</summary>

- Raises the starter test's minimum Pester version from 6.0.0 to 6.1.0.
- Adds the canonical generated documentation URL to the starter
function's comment-based help.
- Aligns `.github/zensical.toml` with `MSXOrg/docs` at
`bc6c212b1da6872424543cc6c4d249b1b1f8a845`, with MSX settings taking
precedence over Process-PSModule differences.
- Enables `navigation.indexes` while keeping manual `nav` absent.
- Keeps generated-site exceptions explicit: no source edit/view actions,
`custom_dir`, JavaScript/CSS assets, `watch`, snippets, or
`[project.extra.consent]`. Cookie consent is intentionally not part of
generated module sites.
- Restricts placeholders to repository identity and content-specific
values.
- Moves `CONTRIBUTING.md` to `.github/CONTRIBUTING.md`, updates
repository links, and aligns its workflow references with current MSX
guidance.
- Links the Code of Conduct, security policy, and support guidance from
the centrally managed `PSModule/.github` source; no local policy
overrides are included.
- Removes `.github/release.yml` because Process-PSModule owns release
generation and does not use GitHub generated release notes.
`.github/PSModule.yml` remains the repository-local workflow settings
surface.
- GitHub's branch contents API resolves `.github/CONTRIBUTING.md` and
`.github/PSModule.yml` and confirms the local policy files, root
contribution duplicate, and `.github/release.yml` are absent.
- Preserves the exact v8 caller workflow, with no `TestData` payload
required.
- Migration inventory: one module-local test file, no external fixtures,
no mocks, no data-driven cases, and no setup or teardown scripts.
- Local validation: Pester 6.1.0 passed; PSScriptAnalyzer 1.25.0
reported no findings; the pinned MSX TOML contract comparison,
codespell, relative-link checks, central-policy link checks, and
file-ownership checks passed; a staged Zensical 0.0.50 build completed
with only the pre-existing README-link warnings tracked by
PSModule/Process-PSModule#523.
- Hosted validation: the full Process-PSModule build, site, source,
module, module-local, lint, result, coverage, and CodeQL checks passed
on Linux, macOS, and Windows at `d92cdc6`.
- Final Copilot review at `d92cdc6` covered all eight changed files and
generated no new comments. Its suppressed quickstart-link note is
already owned by #42 and is not added to this
scope.
- Copilot's earlier scaffold-link concern cannot use the suggested
placeholder without failing the framework's exact-link test; the
initialization gap is recorded separately in
#56, and the review thread is resolved.
- Overlap review: #42 edits the deleted root
contributing guide and needs reconciliation.
#49 also removes `.github/release.yml`, but
its proposed CODEOWNERS and pull-request-template deletions are not
adopted. #50 and #51
remain independent, although #51 touches the same AGENTS link line.
- Issue convergence sweep: the finished diff fully satisfies
#52, #54, and
#55; no other open template issue is completed
by this scope.

| Changed surface | Standards checked | Framework docs checked | Result
|
| --- | --- | --- | --- |
| `tests/**` | MSX PowerShell testing | Process-PSModule Pester 6.1
migration | Fixed in this PR |
| `src/functions/public/**` | MSX PowerShell functions and comment-based
help | Process-PSModule source test contract | Fixed in this PR |
| `.github/zensical.toml` | MSX documentation design | Process-PSModule
Zensical design and staging contract | Fixed in this PR |
| `.github/CONTRIBUTING.md`, `README.md`, `AGENTS.md` | MSX repository
and community guidance | PSModule central policy ownership | Fixed in
this PR |
| `.github/release.yml` | MSX repository configuration |
Process-PSModule release ownership | Fixed in this PR |

</details>

<details>
<summary>Relevant issues (or links)</summary>

- Resolves #52
- Resolves #54
- Resolves #55

### Related work

- References PSModule/Process-PSModule#519
- References PSModule/Process-PSModule#438
- Followed by PSModule/Process-PSModule#523
- Followed by #56
- References MSXOrg/docs#190
- References #42
- References #49
- References #50
- References #51

</details>

---------

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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