fix: resolve broken documentation links causing Doc Build CI failure#23039
Merged
fix: resolve broken documentation links causing Doc Build CI failure#23039
Conversation
Agent-Logs-Url: https://github.com/github/gh-aw/sessions/297ff9b5-8fdc-4372-9a37-de1161ce42f3 Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix failing GitHub Actions workflow build
fix: resolve broken documentation links causing Doc Build CI failure
Mar 26, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes Doc Build CI failures caused by invalid local documentation links by removing a redirect that shadowed an existing page and updating broken anchor hashes to point at valid section IDs.
Changes:
- Removed a stale
/reference/tokens/redirect that conflicted with the actual Token Reference page route. - Updated broken section-anchor links in
tokens.mdto match current headings inengines.md,frontmatter.md, andgithub-tools.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/astro.config.mjs | Removes a redirect that prevented /reference/tokens/ from resolving to the actual page. |
| docs/src/content/docs/reference/tokens.md | Fixes internal anchor hashes to point to existing sections, resolving link-validator failures. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Doc Build - DeployCI job was failing due to 7 invalid links detected bystarlight-links-validatoracross two files.Changes
docs/astro.config.mjs'/reference/tokens/' → '/gh-aw/reference/auth/'that was set up when the tokens content was previously merged intoauth. A newtokens.mdpage was later added at that same path, but the redirect was never removed — causing the link validator to rejectauth.mdx's reference to/gh-aw/reference/tokens/as an invalid link (the redirect page, not the content page, was being resolved).docs/src/content/docs/reference/tokens.md#github-copilot-default#available-coding-agentsengines.md#claude-by-anthropic#available-coding-agentsengines.md#codex-by-openai#available-coding-agentsengines.md#gemini-by-google#available-coding-agentsengines.md#features#feature-flags-featuresfrontmatter.md#remote-vs-local-mode#github-tools-remote-modegithub-tools.mdThe engine entries are listed in a table under
## Available Coding Agentswith no per-engine headings, so all four engine links correctly point to that section.Original prompt
⌨️ Start Copilot coding agent tasks without leaving your editor — available in VS Code, Visual Studio, JetBrains IDEs and Eclipse.