Skip to content

Allow dangling toc definitions in navigation.yml #1539

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 8, 2025
Merged

Allow dangling toc definitions in navigation.yml #1539

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions src/tooling/docs-assembler/Navigation/GlobalNavigationHtmlWriter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,25 @@ private bool TryGetNavigationRoot(
navigationRootSource = null;
if (!assembleSources.TocTopLevelMappings.TryGetValue(navigationSource, out var topLevelMapping))
Copy link
Member Author

@Mpdreamz Mpdreamz Jul 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Long term all of this will go away and we can just query the navigation itself..

{
assembleContext.Collector.EmitWarning(assembleContext.NavigationPath.FullName, $"Could not find a top level mapping for {navigationSource}");
if (assembleSources.TreeCollector.TryGetTableOfContentsTree(navigationSource, out navigationRoot))
{
if (navigationRoot.Parent is DocumentationGroup parent &&
assembleSources.TocTopLevelMappings.TryGetValue(parent.NavigationSource, out var topLevelMapping2))
{
navigationRootSource = topLevelMapping2.TopLevelSource;
return true;
}

assembleContext.Collector.EmitError(assembleContext.NavigationPath.FullName, $"The following toc: {navigationSource} is not declared in navigation.yml and it's parent failed to yield a navigation root.");
return false;
}
assembleContext.Collector.EmitError(assembleContext.NavigationPath.FullName, $"The following toc: {navigationSource} is not declared in navigation.yml");
return false;
}

if (!assembleSources.TreeCollector.TryGetTableOfContentsTree(topLevelMapping.TopLevelSource, out navigationRoot))
{
assembleContext.Collector.EmitWarning(assembleContext.NavigationPath.FullName, $"Could not find a toc tree for {topLevelMapping.TopLevelSource}");
assembleContext.Collector.EmitError(assembleContext.NavigationPath.FullName, $"None of the assemble sources define a toc for: {topLevelMapping.TopLevelSource}");
return false;
}
navigationRootSource = topLevelMapping.TopLevelSource;
Expand Down
Loading