Validate docfx links in documentation workflow - #1654
Merged
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 495c2400-a187-472f-a93a-623465acf571
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation validation workflow so the Markup Link Checker (mlc) also scans the docfx documentation tree, then fixes the newly surfaced broken links so doc validation is reliable again.
Changes:
- Removed the
-p docfxexclusion from the documentation link-check workflow and expanded the redirect-destination allowlist. - Replaced an internal SharePoint link in the cookbook with a public Learn link.
- Switched an analyzer doc link from an absolute GitHub
blob/main/...URL to a local relative link within the docfx tree.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docfx/docs/cookbook_vs.md | Replaces a broken/private reference link with a public Learn page (and updates link reference definitions). |
| docfx/analyzers/VSTHRD001.md | Converts a GitHub blob link to a relative docfx link for better portability and validation. |
| .github/workflows/docs_validate.yml | Ensures the link checker scans docfx content and adjusts redirect allowlisting for known redirect destinations. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 495c2400-a187-472f-a93a-623465acf571
Sandy Armstrong (sandyarmstrong)
approved these changes
Aug 24, 2026
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 documentation workflow passed while broken links accumulated under
docfxbecause MLC's-p docfxargument explicitly excluded that directory.Remove the exclusion so MLC scans all documentation, and repair the two broken links it exposes. Approved
aka.msredirects remain validated while their known destinations are allowed to redirect without warnings.