Remove Fetch from CrossLinkResolver, enforce eager fetching of crosslinks#1784
Merged
Mpdreamz merged 3 commits intocrosslinks-in-toc-take-threefrom Aug 27, 2025
Merged
Conversation
…slinks. This removes a hidden requirement on `DocumentationSet` that its resolver is not usable until `DocumentationGenerator.GenerateAll()` has been called. We now enforce `DocumentationSet` receives a `ICrossLinkResolver` that is ready to resolve crosslinks.
Fetch from CrossLinkResolver, enforce eager fetching of crosslinks
theletterf
approved these changes
Aug 27, 2025
Mpdreamz
added a commit
that referenced
this pull request
Sep 9, 2025
* Add crosslinks to toc * Fix errors * Update docs * Add title validation * Add ctx for Cancel * FileNavigationItem can be ignored * Remove redundant code * Move routine * Fix resolution * Fix hx-select-oob for nav crosslinks * Add validation and title as mandatory * Add utility class for crosslink validation * Remove redundant file * Refactor NavCrossLinkValidator * Ensure we inject docs-builder on CI for integration tests as well * allow docs-builder to have local checkout folder on CI * Ensure we hadnle CrossLinkNavigationItem when building the sitemap by ignoring them * Remove `Fetch` from CrossLinkResolver, enforce eager fetching of crosslinks (#1784) * Remove `Fetch` from CrossLinkResolver, enforce eager fetching of crosslinks. This removes a hidden requirement on `DocumentationSet` that its resolver is not usable until `DocumentationGenerator.GenerateAll()` has been called. We now enforce `DocumentationSet` receives a `ICrossLinkResolver` that is ready to resolve crosslinks. * Found more cases of unhandled navigation types * Remove new caching behavior in DocSetConfigurationCrossLinkFetcher --------- Co-authored-by: Martijn Laarman <Mpdreamz@gmail.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
3 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.
Fetchfrom CrossLinkResolver, enforce eager fetching of crosslinks.By removing
FetchfromICrossLinkResolverand enforcing it takes aFetchedCrossLinksdirectly and not aICrossLinkFetcherinstance, we enforce instances ofICrossLinkResolverhave immediate access to resolve.This removes a hidden requirement that
Fetch()needed to be called beforeTryResolve()was usable. It also removes a hidden requirement thatDocumentationSetwas unusable beforeDocumentationGeneratorcalledFetch()on its publicICrossLinkResolverproperty.This PR untangles that making
DocumentationSetimmediately useable after construction.This allows us to build a clean resolved navigation and emit errors/warnings as we build it.
Removing the need to do an asynchronous touchups after construction.
This also allows us to trust the crosslinks are valid as defined on
CrossLinkReferenceand that the urls are valid onCrossLinkNavigationItem.Uncovered two more places where
CrossLinkNavigationItemwas not handled, updating navigation index and parent as part ofGlobalNavigationas part of the assembler build.