Skip to content

Fix navigation ordering #1068

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
Apr 9, 2025
Merged

Fix navigation ordering #1068

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion src/Elastic.Markdown/IO/Navigation/DocumentationGroup.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public interface INavigationItem
string Id { get; }
}

[DebuggerDisplay("Group >{Depth} #{Order} {Group.FolderName}")]
[DebuggerDisplay("Toc >{Depth} #{Order} {Group.FolderName}")]
public record TocNavigationItem(int Order, int Depth, DocumentationGroup Group, Uri Source)
: GroupNavigationItem(Order, Depth, Group)
{
Expand Down
62 changes: 29 additions & 33 deletions src/docs-assembler/Navigation/GlobalNavigation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,6 @@ private IReadOnlyCollection<INavigationItem> BuildNavigation(IReadOnlyCollection
var i = 0;
foreach (var toc in node)
{
if (toc.Source == new Uri("docs-content://reference/apm/"))
{
}

if (!_assembleSources.TreeCollector.TryGetTableOfContentsTree(toc.Source, out var tree))
{
_navigationFile.EmitWarning($"No {nameof(TableOfContentsTree)} found for {toc.Source}");
Expand Down Expand Up @@ -83,44 +79,44 @@ private IReadOnlyCollection<INavigationItem> BuildNavigation(IReadOnlyCollection
var tocChildren = toc.Children.OfType<TocReference>().ToArray();
var tocNavigationItems = BuildNavigation(tocChildren, depth + 1);

var allNavigationItems = new List<INavigationItem>();
var seenSources = new HashSet<Uri>();
var allNavigationItems =
depth == 0
? tocNavigationItems.Concat(tree.NavigationItems)
: tree.NavigationItems.Concat(tocNavigationItems);

AddNavigationItems(allNavigationItems, tree.NavigationItems, seenSources, tree);
AddNavigationItems(allNavigationItems, tocNavigationItems, seenSources, tree);
var cleanNavigationItems = new List<INavigationItem>();
var seenSources = new HashSet<Uri>();
foreach (var allNavigationItem in allNavigationItems)
{
if (allNavigationItem is not TocNavigationItem tocNav)
{
cleanNavigationItems.Add(allNavigationItem);
continue;
}
if (seenSources.Contains(tocNav.Source))
continue;

tree.NavigationItems = allNavigationItems.ToArray();
var navigationItem = new TocNavigationItem(i, depth, tree, toc.Source);
if (!_assembleSources.TocTopLevelMappings.TryGetValue(tocNav.Source, out var mapping))
continue;

list.Add(navigationItem);
i++;
}
if (mapping.ParentSource != tree.Source)
continue;

return list.ToArray().AsReadOnly();
}
_ = seenSources.Add(tocNav.Source);
cleanNavigationItems.Add(allNavigationItem);
}

private void AddNavigationItems(List<INavigationItem> navigationItems, IEnumerable<INavigationItem>? toAdd, HashSet<Uri> seenSources, TableOfContentsTree tree)
{
if (toAdd is null)
return;
foreach (var navigationItem in toAdd)
{
if (navigationItem is not TocNavigationItem tocNav)
tree.NavigationItems = cleanNavigationItems.ToArray();
var navigationItem = new TocNavigationItem(i, depth, tree, toc.Source);
if (toc.Source == new Uri("docs-content://reference"))
{
navigationItems.Add(navigationItem);
continue;
}
if (seenSources.Contains(tocNav.Source))
continue;

if (!_assembleSources.TocTopLevelMappings.TryGetValue(tocNav.Source, out var mapping))
continue;

if (mapping.ParentSource != tree.Source)
continue;

_ = seenSources.Add(tocNav.Source);
navigationItems.Add(navigationItem);
list.Add(navigationItem);
i++;
}

return list.ToArray().AsReadOnly();
}
}
Loading