Better approach to set the title on directives in LLM markdown output (#1596)

* Set interface ITitledBlock on blocks that have a Title property and use that in LlmDirectiveRenderer

* Skip rendering the title for note, tip, warning and important admonitions

* Remove commented code

* Rename to IBlockTitle

Author: reakaleek

src/Elastic.Markdown/Myst/Directives/Admonition/AdmonitionBlock.cs

@@ -8,7 +8,7 @@ namespace Elastic.Markdown.Myst.Directives.Admonition;
 
 public class DropdownBlock(DirectiveBlockParser parser, ParserContext context) : AdmonitionBlock(parser, "dropdown", context);
 
-public class AdmonitionBlock : DirectiveBlock
+public class AdmonitionBlock : DirectiveBlock, IBlockTitle
 {
 	public AdmonitionBlock(DirectiveBlockParser parser, string admonition, ParserContext context) : base(parser, context)
 	{
@@ -45,5 +45,3 @@ public override void FinalizeAndValidate(ParserContext context)
 		Title = Title.ReplaceSubstitutions(context);
 	}
 }
-
-

src/Elastic.Markdown/Myst/Directives/DirectiveBlock.cs

@@ -13,6 +13,11 @@
 
 namespace Elastic.Markdown.Myst.Directives;
 
+public interface IBlockTitle
+{
+	string Title { get; }
+}
+
 public interface IBlockExtension : IBlock
 {
 	BuildContext Build { get; }

src/Elastic.Markdown/Myst/Directives/Stepper/StepperBlock.cs

@@ -16,7 +16,7 @@ public override void FinalizeAndValidate(ParserContext context)
 	}
 }
 
-public class StepBlock(DirectiveBlockParser parser, ParserContext context) : DirectiveBlock(parser, context)
+public class StepBlock(DirectiveBlockParser parser, ParserContext context) : DirectiveBlock(parser, context), IBlockTitle
 {
 	public override string Directive => "step";
 	public string Title { get; private set; } = string.Empty;

src/Elastic.Markdown/Myst/Directives/Tabs/TabSetBlock.cs

@@ -33,7 +33,7 @@ public int FindIndex()
 }
 
 public class TabItemBlock(DirectiveBlockParser parser, ParserContext context)
-	: DirectiveBlock(parser, context)
+	: DirectiveBlock(parser, context), IBlockTitle
 {
 	public override string Directive => "tab-item";
 

src/Elastic.Markdown/Myst/Renderers/LlmMarkdown/LlmBlockRenderers.cs

@@ -8,7 +8,6 @@
 using Elastic.Markdown.Myst.Directives.Admonition;
 using Elastic.Markdown.Myst.Directives.Image;
 using Elastic.Markdown.Myst.Directives.Include;
-using Elastic.Markdown.Myst.Directives.Tabs;
 using Markdig.Extensions.DefinitionLists;
 using Markdig.Extensions.Tables;
 using Markdig.Extensions.Yaml;
@@ -384,14 +383,13 @@ protected override void Write(LlmMarkdownRenderer renderer, DirectiveBlock obj)
 
 		switch (obj)
 		{
-			case DropdownBlock dropdown:
-				renderer.Writer.Write($" title=\"{dropdown.Title}\"");
+			case AdmonitionBlock when obj.Directive
+				is "note" or "tip" or "warning" or "important":
+				// skip for these directives
+				// otherwise it will render as <note title="Note">
 				break;
-			case TabItemBlock tabItem:
-				renderer.Writer.Write($" title=\"{tabItem.Title}\"");
-				break;
-			case AdmonitionBlock admonition when obj.Directive is "admonition":
-				renderer.Writer.Write($" title=\"{admonition.Title}\"");
+			case IBlockTitle titledBlock:
+				renderer.Writer.Write($" title=\"{titledBlock.Title}\"");
 				break;
 		}