[Draft] Build navigation from scratch

Directory.Packages.props

@@ -23,6 +23,7 @@
     <PackageVersion Include="AWSSDK.Core" Version="4.0.0.2" />
     <PackageVersion Include="AWSSDK.SQS" Version="4.0.0.1" />
     <PackageVersion Include="AWSSDK.S3" Version="4.0.0.1" />
+    <PackageVersion Include="Generator.Equals" Version="3.2.1"  PrivateAssets="all" IncludeAssets="runtime; build; native; contentfiles; analyzers; buildtransitive"/>
     <PackageVersion Include="KubernetesClient" Version="17.0.14" />
     <PackageVersion Include="Elastic.Aspire.Hosting.Elasticsearch" Version="9.3.0" />
     <PackageVersion Include="Elastic.Clients.Elasticsearch" Version="9.1.4" />

README.md

@@ -1,4 +1,4 @@
-# docs-builder
+#ocs-builder
 
 [![ci](https://github.com/elastic/docs-builder/actions/workflows/ci.yml/badge.svg?branch=main&event=push)](https://github.com/elastic/docs-builder/actions/workflows/ci.yml)
 

docs/_docset.yml

@@ -1,3 +1,3 @@
 project: 'doc-builder'
 max_toc_depth: 2
 # indicates this documentation set is not linkable by assembler.
@@ -174,6 +174,8 @@
       - file: index.md
       - file: req.md
       - folder: nested
+        children:
+          - file: index.md
       - file: cross-links.md
         children:
           - title: "Getting Started Guide"

src/Elastic.ApiExplorer/ApiIndexLeafNavigation.cs

@@ -0,0 +1,39 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
+using Elastic.Documentation.Navigation;
+
+namespace Elastic.ApiExplorer;
+
+public class ApiIndexLeafNavigation<TModel>(
+	TModel model, string url, string navigationTitle,
+	IRootNavigationItem<INavigationModel, INavigationItem> rootNavigation,
+	INodeNavigationItem<INavigationModel, INavigationItem>? parent = null
+) : ILeafNavigationItem<TModel>
+	where TModel : IApiModel
+{
+	/// <inheritdoc />
+	public string Url { get; } = url;
+
+	/// <inheritdoc />
+	public string NavigationTitle { get; } = navigationTitle;
+
+	/// <inheritdoc />
+	public IRootNavigationItem<INavigationModel, INavigationItem> NavigationRoot { get; } = rootNavigation;
+
+	/// <inheritdoc />
+	public INodeNavigationItem<INavigationModel, INavigationItem>? Parent { get; set; } = parent;
+
+	/// <inheritdoc />
+	public bool Hidden { get; }
+
+	/// <inheritdoc />
+	public int NavigationIndex { get; set; }
+
+	/// <inheritdoc />
+	public bool IsCrossLink { get; }
+
+	/// <inheritdoc />
+	public TModel Model { get; } = model;
+}

src/Elastic.ApiExplorer/ApiRenderContext.cs

@@ -4,6 +4,7 @@
 
 using Elastic.Documentation;
 using Elastic.Documentation.Configuration;
+using Elastic.Documentation.Navigation;
 using Elastic.Documentation.Site.FileProviders;
 using Elastic.Documentation.Site.Navigation;
 using Microsoft.OpenApi.Models;

src/Elastic.ApiExplorer/ApiViewModel.cs

@@ -7,9 +7,9 @@
 using Elastic.Documentation.Configuration.Assembler;
 using Elastic.Documentation.Configuration.Builder;
 using Elastic.Documentation.Extensions;
+using Elastic.Documentation.Navigation;
 using Elastic.Documentation.Site;
 using Elastic.Documentation.Site.FileProviders;
-using Elastic.Documentation.Site.Navigation;
 using Microsoft.AspNetCore.Html;
 
 namespace Elastic.ApiExplorer;

src/Elastic.ApiExplorer/Endpoints/ApiEndpoint.cs

@@ -3,6 +3,7 @@
 // See the LICENSE file in the project root for more information
 
 using System.IO.Abstractions;
+using Elastic.Documentation.Navigation;
 using Elastic.Documentation.Site.Navigation;
 using Microsoft.OpenApi.Models.Interfaces;
 using RazorSlices;

src/Elastic.ApiExplorer/Landing/LandingNavigationItem.cs

@@ -5,7 +5,7 @@
 using System.IO.Abstractions;
 using Elastic.ApiExplorer.Operations;
 using Elastic.Documentation.Extensions;
-using Elastic.Documentation.Site.Navigation;
+using Elastic.Documentation.Navigation;
 using RazorSlices;
 
 namespace Elastic.ApiExplorer.Landing;
@@ -29,27 +29,23 @@ public class LandingNavigationItem : IApiGroupingNavigationItem<ApiLanding, INav
 	public IRootNavigationItem<INavigationModel, INavigationItem> NavigationRoot { get; }
 	public string Id { get; }
 	public int Depth { get; }
-	public ApiLanding Index { get; }
+	public ILeafNavigationItem<ApiLanding> Index { get; }
 	public IReadOnlyCollection<INavigationItem> NavigationItems { get; set; } = [];
 	public INodeNavigationItem<INavigationModel, INavigationItem>? Parent { get; set; }
 	public int NavigationIndex { get; set; }
 	public bool IsCrossLink => false; // API landing items are never cross-links
-	public string Url { get; }
+	public string Url => Index.Url;
 	public bool Hidden => false;
 
-	//TODO
-	public string NavigationTitle { get; } = "API Overview";
+	public string NavigationTitle => Index.NavigationTitle;
 
 	public LandingNavigationItem(string url)
 	{
 		Depth = 0;
 		NavigationRoot = this;
 		Id = ShortId.Create("root");
-
 		var landing = new ApiLanding();
-		Url = url;
-
-		Index = landing;
+		Index = new ApiIndexLeafNavigation<ApiLanding>(landing, url, "Api Overview", this);
 	}
 
 	/// <inheritdoc />
@@ -63,7 +59,8 @@ public interface IApiGroupingNavigationItem<out TGroupingModel, out TNavigationI
 public abstract class ApiGroupingNavigationItem<TGroupingModel, TNavigationItem>(
 	TGroupingModel groupingModel,
 	IRootNavigationItem<IApiGroupingModel, INavigationItem> rootNavigation,
-	INodeNavigationItem<INavigationModel, INavigationItem> parent)
+	INodeNavigationItem<INavigationModel, INavigationItem> parent
+)
 	: IApiGroupingNavigationItem<TGroupingModel, TNavigationItem>
 	where TGroupingModel : IApiGroupingModel
 	where TNavigationItem : INavigationItem
@@ -91,8 +88,10 @@ public abstract class ApiGroupingNavigationItem<TGroupingModel, TNavigationItem>
 
 	/// <inheritdoc />
 	public abstract string Id { get; }
+
+	//TODO ensure Index is not newed everytime
 	/// <inheritdoc />
-	public TGroupingModel Index { get; } = groupingModel;
+	public ILeafNavigationItem<TGroupingModel> Index => new ApiIndexLeafNavigation<TGroupingModel>(groupingModel, Url, NavigationTitle, rootNavigation, Parent);
 
 	/// <inheritdoc />
 	public IReadOnlyCollection<TNavigationItem> NavigationItems { get; set; } = [];
@@ -151,8 +150,9 @@ public class EndpointNavigationItem(ApiEndpoint endpoint, IRootNavigationItem<IA
 	/// <inheritdoc />
 	public string Id { get; } = ShortId.Create(nameof(EndpointNavigationItem), endpoint.Operations.First().ApiName, endpoint.Operations.First().Route);
 
+	//TODO ensure Index is not newed everytime
 	/// <inheritdoc />
-	public ApiEndpoint Index { get; } = endpoint;
+	public ILeafNavigationItem<ApiEndpoint> Index => new ApiIndexLeafNavigation<ApiEndpoint>(endpoint, Url, NavigationTitle, rootNavigation, Parent);
 
 	/// <inheritdoc />
 	public IReadOnlyCollection<OperationNavigationItem> NavigationItems { get; set; } = [];

src/Elastic.ApiExplorer/Landing/LandingView.cshtml

@@ -1,6 +1,7 @@
 @inherits RazorSliceHttpResult<Elastic.ApiExplorer.Landing.LandingViewModel>
 @using Elastic.ApiExplorer.Landing
 @using Elastic.ApiExplorer.Operations
+@using Elastic.Documentation.Navigation
 @using Elastic.Documentation.Site.Navigation
 @implements IUsesLayout<Elastic.ApiExplorer._Layout, GlobalLayoutViewModel>
 @functions {

src/Elastic.ApiExplorer/OpenApiGenerator.cs

@@ -8,6 +8,7 @@
 using Elastic.ApiExplorer.Operations;
 using Elastic.Documentation;
 using Elastic.Documentation.Configuration;
+using Elastic.Documentation.Navigation;
 using Elastic.Documentation.Site.FileProviders;
 using Elastic.Documentation.Site.Navigation;
 using Microsoft.Extensions.Logging;
@@ -265,7 +266,7 @@ public async Task Generate(Cancel ctx = default)
 				CurrentNavigation = navigation,
 				MarkdownRenderer = markdownStringRenderer
 			};
-			_ = await Render(prefix, navigation, navigation.Index, renderContext, navigationRenderer, ctx);
+			_ = await Render(prefix, navigation, navigation.Index.Model, renderContext, navigationRenderer, ctx);
 			await RenderNavigationItems(prefix, renderContext, navigationRenderer, navigation, ctx);
 
 		}
@@ -275,7 +276,7 @@ private async Task RenderNavigationItems(string prefix, ApiRenderContext renderC
 	{
 		if (currentNavigation is INodeNavigationItem<IApiModel, INavigationItem> node)
 		{
-			_ = await Render(prefix, node, node.Index, renderContext, navigationRenderer, ctx);
+			_ = await Render(prefix, node, node.Index.Model, renderContext, navigationRenderer, ctx);
 			foreach (var child in node.NavigationItems)
 				await RenderNavigationItems(prefix, renderContext, navigationRenderer, child, ctx);
 		}

src/Elastic.ApiExplorer/Operations/OperationNavigationItem.cs

@@ -5,7 +5,7 @@
 using System.IO.Abstractions;
 using Elastic.ApiExplorer.Landing;
 using Elastic.Documentation.Extensions;
-using Elastic.Documentation.Site.Navigation;
+using Elastic.Documentation.Navigation;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Models.Interfaces;
 using RazorSlices;

src/Elastic.Documentation.Configuration/Assembler/AssemblyConfiguration.cs

@@ -5,7 +5,6 @@
 using System.Text.RegularExpressions;
 using Elastic.Documentation.Extensions;
 using YamlDotNet.Serialization;
-using YamlStaticContext = Elastic.Documentation.Configuration.Serialization.YamlStaticContext;
 
 namespace Elastic.Documentation.Configuration.Assembler;
 

src/Elastic.Documentation.Configuration/BuildContext.cs

@@ -6,6 +6,7 @@
 using System.Reflection;
 using Elastic.Documentation.Configuration.Assembler;
 using Elastic.Documentation.Configuration.Builder;
+using Elastic.Documentation.Configuration.DocSet;
 using Elastic.Documentation.Configuration.LegacyUrlMappings;
 using Elastic.Documentation.Configuration.Products;
 using Elastic.Documentation.Configuration.Versions;
@@ -28,6 +29,8 @@ public record BuildContext : IDocumentationSetContext, IDocumentationConfigurati
 
 	public ConfigurationFile Configuration { get; }
 
+	public DocumentationSetFile ConfigurationYaml { get; set; }
+
 	public VersionsConfiguration VersionsConfiguration { get; }
 	public ConfigurationFileProvider ConfigurationFileProvider { get; }
 	public DocumentationEndpoints Endpoints { get; }
@@ -108,9 +111,13 @@ public BuildContext(
 
 		Git = gitCheckoutInformation ?? GitCheckoutInformation.Create(DocumentationCheckoutDirectory, ReadFileSystem);
 		Configuration = new ConfigurationFile(this, VersionsConfiguration, ProductsConfiguration);
+
+		var yaml = readFileSystem.File.ReadAllText(Configuration.SourceFile.FullName);
+		ConfigurationYaml = DocumentationSetFile.Deserialize(yaml);
 		GoogleTagManager = new GoogleTagManagerConfiguration
 		{
 			Enabled = false
 		};
 	}
+
 }

src/Elastic.Documentation.Configuration/Builder/ConfigurationFile.cs

@@ -39,10 +39,6 @@ public record ConfigurationFile : ITableOfContentsScope
 
 	public HashSet<Product> Products { get; } = [];
 
-	public HashSet<string> ImplicitFolders { get; } = new(StringComparer.OrdinalIgnoreCase);
-
-	public Glob[] Globs { get; } = [];
-
 	private readonly Dictionary<string, string> _substitutions = new(StringComparer.OrdinalIgnoreCase);
 	public IReadOnlyDictionary<string, string> Substitutions => _substitutions;
 
@@ -195,8 +191,6 @@ public ConfigurationFile(IDocumentationSetContext context, VersionsConfiguration
 			reader.EmitError("Could not load docset.yml", e);
 			throw;
 		}
-
-		Globs = [.. ImplicitFolders.Select(f => Glob.Parse($"{f}{Path.DirectorySeparatorChar}*.md"))];
 	}
 
 }

src/Elastic.Documentation.Configuration/Builder/TableOfContentsConfiguration.cs

@@ -240,12 +240,7 @@ file is null && crossLink is null && folder is null && toc is null &&
 		}
 
 		if (folder is not null)
-		{
-			if (children is null)
-				_ = _configuration.ImplicitFolders.Add(parentPath.TrimStart(Path.DirectorySeparatorChar));
-
 			return [new FolderReference(this, $"{parentPath}".TrimStart(Path.DirectorySeparatorChar), children ?? [])];
-		}
 
 		return null;
 	}

src/Elastic.Documentation.Configuration/ConfigurationFileProvider.cs

@@ -5,6 +5,7 @@
 using System.IO.Abstractions;
 using System.Text.RegularExpressions;
 using Elastic.Documentation.Configuration.Assembler;
+using Elastic.Documentation.Configuration.DocSet;
 using Elastic.Documentation.Configuration.Serialization;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
@@ -21,6 +22,10 @@ public partial class ConfigurationFileProvider
 
 	internal static IDeserializer Deserializer { get; } = new StaticDeserializerBuilder(new YamlStaticContext())
 		.WithNamingConvention(UnderscoredNamingConvention.Instance)
+		.WithTypeConverter(new TocItemCollectionYamlConverter())
+		.WithTypeConverter(new TocItemYamlConverter())
+		.WithTypeConverter(new SiteTableOfContentsCollectionYamlConverter())
+		.WithTypeConverter(new SiteTableOfContentsRefYamlConverter())
 		.Build();
 
 	public ConfigurationSource ConfigurationSource { get; }