-
Notifications
You must be signed in to change notification settings - Fork 27
Add crosslinks to toc: in docset.yml #1615
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
🔍 Preview links for changed docs |
@Mpdreamz @bmorelli25 Wanted to give this one a try. Seems to work (check the Testing section, last two items). If the code is ugly, please feel free to salvage whatever looks useful in this PR, or commit directly. |
src/Elastic.Markdown/IO/Navigation/NavigationCrossLinkValidator.cs
Outdated
Show resolved
Hide resolved
src/Elastic.Markdown/IO/Navigation/NavigationCrossLinkValidator.cs
Outdated
Show resolved
Hide resolved
src/Elastic.Markdown/Links/CrossLinks/ConfigurationCrossLinkFetcher.cs
Outdated
Show resolved
Hide resolved
@Mpdreamz Anything missing for this one? Minus the remaining comment. |
@Mpdreamz I've added a utility class to validate crosslinks, used for both the Markdown or in the nav. With...
The following warnings appear:
|
This PR is finally failing like I was expecting it too :) https://github.com/elastic/docs-builder/actions/runs/17245378751/job/48933555065?pr=1615#step:5:154 The sitemap builder does not yet know about the new CrosslinkReference type, will amend the PR. |
…slinks (#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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM but want @cotti to review as well since I did a bunch of changes here as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
This PR adds crosslinks as accepted item types in docset.yml toc directives.
For example: