Add crosslinks to toc: in docset.yml (#1615)

* Add crosslinks to toc

* Fix errors

* Update docs

* Add title validation

* Add ctx for Cancel

* FileNavigationItem can be ignored

* Remove redundant code

* Move routine

* Fix resolution

* Fix hx-select-oob for nav crosslinks

* Add validation and title as mandatory

* Add utility class for crosslink validation

* Remove redundant file

* Refactor NavCrossLinkValidator

* Ensure we inject docs-builder on CI for integration tests as well

* allow docs-builder to have local checkout folder on CI

* Ensure we hadnle CrossLinkNavigationItem when building the sitemap by ignoring them

* Remove `Fetch` from CrossLinkResolver, enforce eager fetching of crosslinks (#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

---------

Co-authored-by: Martijn Laarman <[email protected]>

Author: theletterf

docs-builder.sln.DotSettings

@@ -1,4 +1,5 @@
 <wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=crosslink/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=docset/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=frontmatter/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=linenos/@EntryIndexedValue">True</s:Boolean>

docs/_docset.yml

@@ -129,6 +129,9 @@ toc:
       - file: req.md
       - folder: nested
       - file: cross-links.md
+        children:
+          - title: "Getting Started Guide"
+            crosslink: docs-content://get-started/introduction.md
       - file: custom-highlighters.md
       - hidden: archive.md
       - hidden: landing-page.md
@@ -153,4 +156,4 @@ toc:
           - file: bar.md
           - folder: baz
             children:
-              - file: qux.md
+              - file: qux.md

docs/configure/content-set/navigation.md

@@ -72,12 +72,38 @@ cross_links:
   - docs-content
 ```
 
+#### Adding cross-links in Markdown content
+
 To link to a document in the `docs-content` repository, you would write the link as follows:
 
-```
+```markdown
 [Link to docs-content doc](docs-content://directory/another-directory/file.md)
 ```
 
+You can also link to specific anchors within the document:
+
+```markdown
+[Link to specific section](docs-content://directory/file.md#section-id)
+```
+
+#### Adding cross-links in navigation
+
+Cross-links can also be included in navigation structures. When creating a `toc.yml` file or defining navigation in `docset.yml`, you can add cross-links as follows:
+
+```yaml
+toc:
+  - file: index.md
+  - title: External Documentation
+    crosslink: docs-content://directory/file.md
+  - folder: local-section
+    children:
+      - file: index.md
+      - title: API Reference
+        crosslink: elasticsearch://api/index.html
+```
+
+Cross-links in navigation will be automatically resolved during the build process, maintaining consistent linking between related documentation across repositories.
+
 ### `exclude`
 
 Files to exclude from the TOC. Supports glob patterns.

src/Elastic.ApiExplorer/Landing/LandingNavigationItem.cs

@@ -33,6 +33,7 @@ public class LandingNavigationItem : IApiGroupingNavigationItem<ApiLanding, INav
 	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 bool Hidden => false;
 
@@ -83,6 +84,7 @@ public abstract class ApiGroupingNavigationItem<TGroupingModel, TNavigationItem>
 	public bool Hidden => false;
 	/// <inheritdoc />
 	public int NavigationIndex { get; set; }
+	public bool IsCrossLink => false; // API grouping items are never cross-links
 
 	/// <inheritdoc />
 	public int Depth => 0;
@@ -141,6 +143,7 @@ public class EndpointNavigationItem(ApiEndpoint endpoint, IRootNavigationItem<IA
 
 	/// <inheritdoc />
 	public int NavigationIndex { get; set; }
+	public bool IsCrossLink => false; // API endpoint items are never cross-links
 
 	/// <inheritdoc />
 	public int Depth => 0;

src/Elastic.ApiExplorer/Operations/OperationNavigationItem.cs

@@ -70,5 +70,6 @@ IApiGroupingNavigationItem<IApiGroupingModel, INavigationItem> parent
 	public INodeNavigationItem<INavigationModel, INavigationItem>? Parent { get; set; }
 
 	public int NavigationIndex { get; set; }
+	public bool IsCrossLink => false; // API operations are never cross-links
 
 }

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

@@ -31,9 +31,9 @@ public static AssemblyConfiguration Deserialize(string yaml, bool skipPrivateRep
 				config.ReferenceRepositories[name] = repository;
 			}
 
-			// if we are not running in CI, and we are skipping private repositories, and we can locate the solution directory. build the local docs-content repository
-			if (string.IsNullOrWhiteSpace(Environment.GetEnvironmentVariable("CI"))
-				&& skipPrivateRepositories
+			// If we are skipping private repositories, and we can locate the solution directory. include the local docs-content repository
+			// this allows us to test new docset features as part of the assembler build
+			if (skipPrivateRepositories
 				&& config.ReferenceRepositories.TryGetValue("docs-builder", out var docsContentRepository)
 				&& Paths.GetSolutionDirectory() is { } solutionDir
 			)

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

@@ -6,6 +6,7 @@
 using System.Runtime.InteropServices;
 using Elastic.Documentation.Configuration.Plugins.DetectionRules.TableOfContents;
 using Elastic.Documentation.Configuration.TableOfContents;
+using Elastic.Documentation.Links;
 using Elastic.Documentation.Navigation;
 using YamlDotNet.RepresentationModel;
 
@@ -129,6 +130,8 @@ private IReadOnlyCollection<ITocItem> ReadChildren(YamlStreamReader reader, KeyV
 	private IEnumerable<ITocItem>? ReadChild(YamlStreamReader reader, YamlMappingNode tocEntry, string parentPath)
 	{
 		string? file = null;
+		string? crossLink = null;
+		string? title = null;
 		string? folder = null;
 		string[]? detectionRules = null;
 		TableOfContentsConfiguration? toc = null;
@@ -148,6 +151,19 @@ private IReadOnlyCollection<ITocItem> ReadChildren(YamlStreamReader reader, KeyV
 					hiddenFile = key == "hidden";
 					file = ReadFile(reader, entry, parentPath);
 					break;
+				case "title":
+					title = reader.ReadString(entry);
+					break;
+				case "crosslink":
+					hiddenFile = false;
+					crossLink = reader.ReadString(entry);
+					// Validate crosslink URI early
+					if (!CrossLinkValidator.IsValidCrossLink(crossLink, out var errorMessage))
+					{
+						reader.EmitError(errorMessage!, tocEntry);
+						crossLink = null; // Reset to prevent further processing
+					}
+					break;
 				case "folder":
 					folder = ReadFolder(reader, entry, parentPath);
 					parentPath += $"{Path.DirectorySeparatorChar}{folder}";
@@ -165,6 +181,22 @@ private IReadOnlyCollection<ITocItem> ReadChildren(YamlStreamReader reader, KeyV
 			}
 		}
 
+		// Validate that crosslink entries have titles
+		if (crossLink is not null && string.IsNullOrWhiteSpace(title))
+		{
+			reader.EmitError($"Cross-link entries must have a 'title' specified. Cross-link: {crossLink}", tocEntry);
+			return null;
+		}
+
+		// Validate that standalone titles (without content) are not allowed
+		if (!string.IsNullOrWhiteSpace(title) &&
+			file is null && crossLink is null && folder is null && toc is null &&
+			(detectionRules is null || detectionRules.Length == 0))
+		{
+			reader.EmitError($"Table of contents entries with only a 'title' are not allowed. Entry must specify content (file, crosslink, folder, or toc). Title: '{title}'", tocEntry);
+			return null;
+		}
+
 		if (toc is not null)
 		{
 			foreach (var f in toc.Files)
@@ -199,6 +231,14 @@ private IReadOnlyCollection<ITocItem> ReadChildren(YamlStreamReader reader, KeyV
 			return [new FileReference(this, path, hiddenFile, children ?? [])];
 		}
 
+		if (crossLink is not null)
+		{
+			if (Uri.TryCreate(crossLink, UriKind.Absolute, out var crossUri) && CrossLinkValidator.IsCrossLink(crossUri))
+				return [new CrossLinkReference(this, crossUri, title, hiddenFile, children ?? [])];
+			else
+				reader.EmitError($"Cross-link '{crossLink}' is not a valid absolute URI format", tocEntry);
+		}
+
 		if (folder is not null)
 		{
 			if (children is null)

src/Elastic.Documentation.Configuration/TableOfContents/ITocItem.cs

@@ -14,6 +14,9 @@ public interface ITocItem
 public record FileReference(ITableOfContentsScope TableOfContentsScope, string RelativePath, bool Hidden, IReadOnlyCollection<ITocItem> Children)
 	: ITocItem;
 
+public record CrossLinkReference(ITableOfContentsScope TableOfContentsScope, Uri CrossLinkUri, string? Title, bool Hidden, IReadOnlyCollection<ITocItem> Children)
+	: ITocItem;
+
 public record FolderReference(ITableOfContentsScope TableOfContentsScope, string RelativePath, IReadOnlyCollection<ITocItem> Children)
 	: ITocItem;
 

src/Elastic.Documentation.Site/Navigation/INavigationItem.cs

@@ -34,6 +34,9 @@ public interface INavigationItem
 	bool Hidden { get; }
 
 	int NavigationIndex { get; set; }
+
+	/// Gets whether this navigation item is a cross-link to another repository.
+	bool IsCrossLink { get; }
 }
 
 /// Represents a leaf node in the navigation tree with associated model data.

src/Elastic.Documentation.Site/Navigation/_TocTreeNav.cshtml

@@ -79,10 +79,11 @@
 	}
 	else if (item is ILeafNavigationItem<INavigationModel> leaf)
 	{
+		var hasSameTopLevelGroup = !leaf.IsCrossLink && (Model.IsPrimaryNavEnabled && leaf.NavigationRoot.Id == Model.RootNavigationId || true);
 		<li class="flex group/li pr-8 @(isTopLevel ? "font-semibold mt-6" : "mt-4")">
 			<a
 				href="@leaf.Url"
-				@Htmx.GetNavHxAttributes(Model.IsPrimaryNavEnabled && leaf.NavigationRoot.Id == Model.RootNavigationId || true)
+				@Htmx.GetNavHxAttributes(hasSameTopLevelGroup)
 				class="sidebar-link grow group-[.current]/li:text-blue-elastic!"
 			>
 				@leaf.NavigationTitle