chore: Add logics to avoid generating invalid link #10854
Merged
Conversation
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
yufeih
approved these changes
Oct 21, 2025
Contributor
Author
|
Current snapshot test don't contains files that are created by Source Generator. I'll expecting to add required test files on another PR after this PR merged. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR intended to fix issue reported by #10850.
What's changed in this PR
Modify
TryGetFileDetailto returnnullwhen input file path contains/obj/path.It seems Roslyn API don't expose public function to get flag that current
SyntaxNodeis generated from Source Generator or not.So this PR simply checking path has
/obj/or not.Other Changes
Update snapshot files with
snapshot.ymlworkflow.This PR affects existing page contents that are generated by
outputFormat: markdown.And invalid
Edit this pagelinks are removed.Background
Mref/ApiPage link is resolved when running
docfx metadatacommand.In contrast, Markdown output format generate plain markdown on
docfx metadatacommand.And
Edit this pagelink is resolved ondocfx buildcommand based on markdown file path.So current existing markdown pages contains invalid links that can't accessible.
Example URLs
Edit this pagelink: https://dotnet.github.io/docfx/seed/md/BuildFromAssembly.html