fix(docs): drop the archived VS Code extension content source - #43
Merged
Conversation
The playbook pulled docs from reqstool-vscode-extension, which is archived and private -- so Antora cannot fetch it and the Pages build has failed since 2026-05-27: FATAL (antora): Content repository not found or requires credentials (url: https://github.com/reqstool/reqstool-vscode-extension) That repo is superseded by reqstool-vscode and is no longer used, so the source is removed rather than repointed: reqstool-vscode carries no docs module to point at. The three pages that cross-referenced the removed module would have rendered as broken links, so they now link to the repository directly. When reqstool-vscode grows a docs module, these can go back to being xrefs and the source can be added again. Signed-off-by: Jimisola Laursen <jimisola@jimisola.com>
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
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.
ⓘ The Pages build has been failing since 2026-05-27. This unblocks it.
What & Why
The playbook pulled docs from
reqstool-vscode-extension, which is archived and private — so Antora cannot fetch it:That repo is superseded by
reqstool-vscodeand is no longer used, so the source is removed rather than repointed —reqstool-vscodecarries no docs module to point at (verified: it has nodocs/directory).Removed from both
docs/antora-playbook.ymlanddocs/local-antora-playbook.yml.The part that is easy to miss
Three pages cross-referenced the removed module:
getting-started.adoc:32xref:reqstool-vscode-extension::index.adocindex.adoc:62components.adoc:81Dropping the source alone would leave these rendering as broken links — Antora treats an unresolved xref as a warning, and the build passes
--log-failure-level=fatal, so it would have gone green while quietly shipping three dead links. They now link to the repository directly.Follow-up
When
reqstool-vscodegrows a docs module, these can go back to being xrefs and the content source can be added again. Worth noting the extension was rewritten, so the archived docs described the old implementation — recovering them verbatim is probably not wanted anyway.Author checklist
vscode-extensionreferences remain anywhere underdocs/Test Plan
CI on this PR builds the site. After merge, Publish to GitHub Pages on
mainshould go green for the first time since May.