fix(docs): point openspec links at GitHub, so the docs site builds - #718
Merged
Merged
Conversation
The Documentation build fails on 22 broken links, which blocks the development -> documentation promotion and therefore any docs deploy. Nine pages linked specs as `../../openspec/specs/<name>/spec.md`. Those files exist in the repo but sit outside the Docusaurus docs tree, so Docusaurus cannot resolve them and treats each as a build error. The count is 22 rather than 11 because every page also has an /nl/ locale build. All eleven links now point at the file on GitHub, which is the only host we publish to. Two were more than a path swap: - portfolio-rationalization-time pointed into `openspec/changes/...`, and that change was archived on 2026-07-23, so the target no longer existed at all. Archiving a change breaks every reference into it. Repointed at the promoted `openspec/specs/portfolio-rationalization-time/spec.md`. - The three REQ-007/008/009 links carried Docusaurus heading anchors. GitHub slugifies headings by its own rules, so re-using those anchors would be inventing a target. The REQ id stays in the link text and the link goes to the spec file. Verified every target exists before writing the URL.
Contributor
Quality Report — ConductionNL/stackiq @
|
| Check | PHP | Vue | Security | License | Tests |
|---|---|---|---|---|---|
| lint | ✅ | ||||
| phpcs | ✅ | ||||
| phpmd | ✅ | ||||
| psalm | ✅ | ||||
| phpstan | ✅ | ||||
| phpmetrics | ✅ | ||||
| eslint | ✅ | ||||
| stylelint | ✅ | ||||
| build | ✅ | ||||
| check-manifest | ✅ | ||||
| check-vue-demi | ✅ | ||||
| test-l10n | ✅ | ||||
| format | ✅ | ||||
| check-schema-l10n | ✅ | ||||
| composer | ✅ | ✅ 130/130 | |||
| npm | ✅ | ✅ 703/703 | |||
| app:check-code | ⏭️ | ||||
| info.xml | ✅ | ||||
| REUSE | ❌ | ||||
| PHPUnit | ✅ | ||||
| Newman | ⏭️ | ||||
| Playwright | ✅ | ||||
| Hydra gates | ✅ |
Quality workflow — 2026-08-24 06:02 UTC
Download the full PDF report from the workflow artifacts.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Blocker for the
development->documentationpromotion in #717: the Documentation build fails on 22 broken links, so no docs deploy can happen.Cause
Nine pages linked specs as
../../openspec/specs/<name>/spec.md. Those files exist in the repo but sit outside the Docusaurus docs tree, so Docusaurus cannot resolve them and treats each as a build error. 22 rather than 11 because every page also builds an/nl/locale.Fix
All eleven links now point at the file on GitHub, the only host we publish to.
Two needed more than a path swap:
portfolio-rationalization-timepointed intoopenspec/changes/..., and that change was archived on 2026-07-23 — the target did not exist any more. Archiving a change breaks every reference into it. Repointed at the promotedopenspec/specs/portfolio-rationalization-time/spec.md.I verified every target exists before writing its URL, so this does not trade a broken relative link for a broken absolute one.