[Draft] Build navigation from scratch

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)
 

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;

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;

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/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;
@@ -20,7 +21,10 @@ public partial class ConfigurationFileProvider
 	private readonly ILogger<ConfigurationFileProvider> _logger;
 
 	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; }

src/Elastic.Documentation.Configuration/DocSet/DocumentationSetFile.cs

@@ -0,0 +1,208 @@
+// 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 YamlDotNet.Core;
+using YamlDotNet.Core.Events;
+using YamlDotNet.Serialization;
+
+namespace Elastic.Documentation.Configuration.DocSet;
+
+[YamlSerializable]
+public class TableOfContentsFile
+{
+	[YamlMember(Alias = "toc")]
+	public TableOfContents Toc { get; set; } = [];
+
+	public static TableOfContentsFile Deserialize(string json) =>
+		ConfigurationFileProvider.Deserializer.Deserialize<TableOfContentsFile>(json);
+}
+
+[YamlSerializable]
+public class DocumentationSetFile : TableOfContentsFile
+{
+	[YamlMember(Alias = "project")]
+	public string? Project { get; set; }
+
+	[YamlMember(Alias = "max_toc_depth")]
+	public int MaxTocDepth { get; set; } = 2;
+
+	[YamlMember(Alias = "dev_docs")]
+	public bool DevDocs { get; set; }
+
+	[YamlMember(Alias = "cross_links")]
+	public List<string> CrossLinks { get; set; } = [];
+
+	[YamlMember(Alias = "exclude")]
+	public List<string> Exclude { get; set; } = [];
+
+	[YamlMember(Alias = "subs")]
+	public Dictionary<string, string> Subs { get; set; } = [];
+
+	[YamlMember(Alias = "features")]
+	public DocumentationSetFeatures Features { get; set; } = new();
+
+	[YamlMember(Alias = "api")]
+	public Dictionary<string, string> Api { get; set; } = [];
+
+	[YamlMember(Alias = "toc")]
+	public new TableOfContents Toc { get; set; } = [];
+
+	public static new DocumentationSetFile Deserialize(string json) =>
+		ConfigurationFileProvider.Deserializer.Deserialize<DocumentationSetFile>(json);
+}
+
+[YamlSerializable]
+public class DocumentationSetFeatures
+{
+	[YamlMember(Alias = "primary-nav")]
+	public bool? PrimaryNav { get; set; }
+}
+
+public class TableOfContents : List<ITableOfContentsItem>
+{
+	public TableOfContents() { }
+
+	public TableOfContents(IEnumerable<ITableOfContentsItem> items) : base(items) { }
+}
+
+
+public interface ITableOfContentsItem;
+
+public record FileRef(string RelativePath, bool Hidden, IReadOnlyCollection<ITableOfContentsItem> Children)
+	: ITableOfContentsItem;
+
+public record IndexFileRef(string RelativePath, bool Hidden, IReadOnlyCollection<ITableOfContentsItem> Children)
+	: FileRef(RelativePath, Hidden, Children);
+
+public record CrossLinkRef(Uri CrossLinkUri, string? Title, bool Hidden, IReadOnlyCollection<ITableOfContentsItem> Children)
+	: ITableOfContentsItem;
+
+public record FolderRef(string RelativePath, IReadOnlyCollection<ITableOfContentsItem> Children)
+	: ITableOfContentsItem;
+
+public record IsolatedTableOfContentsRef(string Source, IReadOnlyCollection<ITableOfContentsItem> Children)
+	: ITableOfContentsItem;
+
+
+public class TocItemCollectionYamlConverter : IYamlTypeConverter
+{
+	public bool Accepts(Type type) => type == typeof(TableOfContents);
+
+	public object ReadYaml(IParser parser, Type type, ObjectDeserializer rootDeserializer)
+	{
+		var collection = new TableOfContents();
+
+		if (!parser.TryConsume<SequenceStart>(out _))
+			return collection;
+
+		while (!parser.TryConsume<SequenceEnd>(out _))
+		{
+			var item = rootDeserializer(typeof(ITableOfContentsItem));
+			if (item is ITableOfContentsItem tocItem)
+				collection.Add(tocItem);
+		}
+
+		return collection;
+	}
+
+	public void WriteYaml(IEmitter emitter, object? value, Type type, ObjectSerializer serializer) =>
+		serializer.Invoke(value, type);
+}
+
+public class TocItemYamlConverter : IYamlTypeConverter
+{
+	public bool Accepts(Type type) => type == typeof(ITableOfContentsItem);
+
+	public object? ReadYaml(IParser parser, Type type, ObjectDeserializer rootDeserializer)
+	{
+		if (!parser.TryConsume<MappingStart>(out _))
+			return null;
+
+		var dictionary = new Dictionary<string, object?>();
+
+		while (!parser.TryConsume<MappingEnd>(out _))
+		{
+			var key = parser.Consume<Scalar>();
+
+			// Parse the value based on what type it is
+			object? value = null;
+			if (parser.Accept<Scalar>(out var scalarValue))
+			{
+				value = scalarValue.Value;
+				_ = parser.MoveNext();
+			}
+			else if (parser.Accept<SequenceStart>(out _))
+			{
+				// This is a list - parse it manually for "children"
+				if (key.Value == "children")
+				{
+					// Parse the children list manually
+					var childrenList = new List<ITableOfContentsItem>();
+					_ = parser.Consume<SequenceStart>();
+					while (!parser.TryConsume<SequenceEnd>(out _))
+					{
+						var child = rootDeserializer(typeof(ITableOfContentsItem));
+						if (child is ITableOfContentsItem tocItem)
+							childrenList.Add(tocItem);
+					}
+					value = childrenList;
+				}
+				else
+				{
+					// For other lists, just skip them
+					parser.SkipThisAndNestedEvents();
+				}
+			}
+			else if (parser.Accept<MappingStart>(out _))
+			{
+				// This is a nested mapping - skip it
+				parser.SkipThisAndNestedEvents();
+			}
+
+			dictionary[key.Value] = value;
+		}
+
+		var children = GetChildren(dictionary);
+
+		// Check for file reference (file: or hidden:)
+		if (dictionary.TryGetValue("file", out var filePath) && filePath is string file)
+			return file == "index.md" ? new IndexFileRef(file, false, children) : new FileRef(file, false, children);
+
+		if (dictionary.TryGetValue("hidden", out var hiddenPath) && hiddenPath is string p)
+			return p == "index.md" ? new IndexFileRef(p, true, children) : new FileRef(p, true, children);
+
+		// Check for crosslink reference
+		if (dictionary.TryGetValue("crosslink", out var crosslink) && crosslink is string crosslinkStr)
+		{
+			var title = dictionary.TryGetValue("title", out var t) && t is string titleStr ? titleStr : null;
+			var isHidden = dictionary.TryGetValue("hidden", out var h) && h is bool hiddenBool && hiddenBool;
+			return new CrossLinkRef(new Uri(crosslinkStr), title, isHidden, children);
+		}
+
+		// Check for folder reference
+		if (dictionary.TryGetValue("folder", out var folderPath) && folderPath is string folder)
+			return new FolderRef(folder, children);
+
+		// Check for toc reference
+		if (dictionary.TryGetValue("toc", out var tocPath) && tocPath is string source)
+			return new IsolatedTableOfContentsRef(source, children);
+
+		return null;
+	}
+
+	private IReadOnlyCollection<ITableOfContentsItem> GetChildren(Dictionary<string, object?> dictionary)
+	{
+		if (!dictionary.TryGetValue("children", out var childrenObj))
+			return [];
+
+		// Children have already been deserialized as List<ITableOfContentsItem>
+		if (childrenObj is List<ITableOfContentsItem> tocItems)
+			return tocItems;
+
+		return [];
+	}
+
+	public void WriteYaml(IEmitter emitter, object? value, Type type, ObjectSerializer serializer) =>
+		serializer.Invoke(value, type);
+}