Repository navigation
docs: fix broken AGENTS.md link failing the docs deployment - #822
Merged
Merged
Conversation
The relative link pointed outside the Sphinx source tree, producing a myst.xref_missing warning that fails the docs build (warnings are errors).
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.
Summary
The Deploy Documentation workflow has been failing on every push to
mainsince #810. That PR added a relative link to../../../AGENTS.mdindocs/source/contributor-guide/03-tests.md. The link points outside the Sphinx source tree, so MyST emits amyst.xref_missingwarning, and the build fails because warnings are treated as errors:This replaces it with the absolute GitHub URL. The other contributor-guide pages already link this way to repo files outside
docs/, such as the benchmarks README.Validation
make htmlindocs/withdocs/requirements.txtinstalled:build succeeded., no warnings.🤖 Generated with Claude Code