-
Notifications
You must be signed in to change notification settings - Fork 34
Render applies_to as readable text in LLM markdown output #2439
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.
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
Changes from 6 commits
17d78a6
809fb58
c2b9180
1c2a134
fcbf94b
0c1252f
e8369f5
b3a3094
5a4c560
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| // 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 System.Text; | ||
| using Elastic.Documentation; | ||
| using Elastic.Documentation.AppliesTo; | ||
| using Elastic.Documentation.Configuration; | ||
| using Elastic.Markdown.Myst.Components; | ||
|
|
||
| namespace Elastic.Markdown.Myst.Renderers.LlmMarkdown; | ||
|
|
||
| /// <summary> | ||
| /// Helper class to render ApplicableTo information in LLM-friendly text format | ||
| /// </summary> | ||
| public static class LlmAppliesToHelper | ||
| { | ||
| /// <summary> | ||
| /// Converts ApplicableTo to a readable text format for LLM consumption (block level - for page or section) | ||
| /// </summary> | ||
| public static string RenderAppliesToBlock(ApplicableTo? appliesTo, IDocumentationConfigurationContext buildContext) | ||
| { | ||
| if (appliesTo is null || appliesTo == ApplicableTo.All) | ||
| return string.Empty; | ||
|
|
||
| var items = GetApplicabilityItems(appliesTo, buildContext); | ||
| if (items.Count == 0) | ||
| return string.Empty; | ||
|
|
||
| var sb = new StringBuilder(); | ||
| _ = sb.AppendLine(); | ||
| _ = sb.AppendLine("This applies to:"); | ||
|
|
||
| foreach (var (productName, availabilityText) in items) | ||
| _ = sb.AppendLine($"- {availabilityText} for {productName}"); | ||
|
|
||
| return sb.ToString(); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Converts ApplicableTo to a readable inline text format for LLM consumption | ||
| /// </summary> | ||
| public static string RenderApplicableTo(ApplicableTo? appliesTo, IDocumentationConfigurationContext buildContext) | ||
| { | ||
| if (appliesTo is null || appliesTo == ApplicableTo.All) | ||
| return string.Empty; | ||
|
|
||
| var items = GetApplicabilityItems(appliesTo, buildContext); | ||
| if (items.Count == 0) | ||
| return string.Empty; | ||
|
|
||
| var itemList = items.Select(item => $"{item.availabilityText} for {item.productName}").ToList(); | ||
| return string.Join(", ", itemList); | ||
| } | ||
|
|
||
| private static List<(string productName, string availabilityText)> GetApplicabilityItems( | ||
| ApplicableTo appliesTo, | ||
| IDocumentationConfigurationContext buildContext) | ||
| { | ||
| var viewModel = new ApplicableToViewModel | ||
| { | ||
| AppliesTo = appliesTo, | ||
| Inline = false, | ||
| ShowTooltip = false, | ||
| VersionsConfig = buildContext.VersionsConfiguration | ||
| }; | ||
|
|
||
| var applicabilityItems = viewModel.GetApplicabilityItems(); | ||
| var results = new List<(string productName, string availabilityText)>(); | ||
|
|
||
| foreach (var item in applicabilityItems) | ||
| { | ||
| var renderData = item.RenderData; | ||
| var productName = item.Key; | ||
|
|
||
| // Get the availability text from the popover data | ||
| var availabilityText = GetAvailabilityText(renderData); | ||
| if (!string.IsNullOrEmpty(availabilityText)) | ||
| results.Add((productName, availabilityText)); | ||
| } | ||
|
|
||
| return results; | ||
| } | ||
|
|
||
| private static string GetAvailabilityText(ApplicabilityRenderer.ApplicabilityRenderData renderData) | ||
| { | ||
| // Use the first availability item's text if available (this is what the popover shows) | ||
| if (renderData.PopoverData?.AvailabilityItems is { Length: > 0 } items) | ||
| { | ||
| // The popover text already includes lifecycle and version info | ||
| // e.g., "Generally available since 9.1", "Preview in 8.0", etc. | ||
| // We use the first item because it represents the most current/relevant status | ||
| // (items are sorted by version descending in ApplicabilityRenderer) | ||
| return items[0].Text; | ||
| } | ||
|
|
||
| // Fallback to constructing from badge data | ||
| var parts = new List<string>(); | ||
|
|
||
| if (!string.IsNullOrEmpty(renderData.LifecycleName) && renderData.LifecycleName != "Generally available") | ||
| parts.Add(renderData.LifecycleName); | ||
|
|
||
| if (!string.IsNullOrEmpty(renderData.Version)) | ||
| parts.Add(renderData.Version); | ||
| else if (!string.IsNullOrEmpty(renderData.BadgeLifecycleText)) | ||
| parts.Add(renderData.BadgeLifecycleText); | ||
|
|
||
| return parts.Count > 0 ? string.Join(" ", parts) : "Available"; | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -133,9 +133,9 @@ This is an inline {applies_to}`stack: preview 9.1` element. | |
| """ | ||
|
|
||
| [<Fact>] | ||
| let ``converts to plain text with optional comment`` () = | ||
| let ``converts to readable text`` () = | ||
| markdown |> convertsToNewLLM """ | ||
| This is an inline `stack: preview 9.1` element. | ||
| This is an inline [Planned for Stack] element. | ||
| """ | ||
|
|
||
| type ``admonition directive`` () = | ||
|
|
@@ -214,15 +214,15 @@ This is a custom admonition with applies_to information. | |
| [<Fact>] | ||
| let ``renders correctly with applies_to information`` () = | ||
| markdown |> convertsToNewLLM """ | ||
| <note applies-to="stack: ga"> | ||
| <note applies-to="Generally available in 8.0+ for Stack"> | ||
| This is a note admonition with applies_to information. | ||
| </note> | ||
|
|
||
| <warning applies-to="serverless: ga"> | ||
| <warning applies-to="Generally available in 8.0+ for Serverless"> | ||
| This is a warning admonition with applies_to information. | ||
| </warning> | ||
|
|
||
| <tip applies-to="elasticsearch: preview"> | ||
| <tip applies-to="Preview in 8.0+ for Serverless Elasticsearch"> | ||
| This is a tip admonition with applies_to information. | ||
| </tip> | ||
|
|
||
|
|
@@ -751,3 +751,38 @@ type ``images in tables`` () = | |
| |---------------------------------------|------| | ||
| |  | Logo | | ||
| """ | ||
|
|
||
| type ``page level applies_to in frontmatter`` () = | ||
| static let markdown = Setup.Document """--- | ||
| applies_to: | ||
| stack: ga 8.5 | ||
| serverless: preview | ||
| --- | ||
|
|
||
| # Test Page | ||
|
|
||
| This is a test page with applies_to frontmatter. | ||
| """ | ||
|
|
||
| [<Fact>] | ||
| let ``parses applies_to frontmatter correctly`` () = | ||
| // Test that the applies_to frontmatter is correctly parsed | ||
| let results = markdown.Value | ||
| let defaultFile = results.MarkdownResults |> Seq.find (fun r -> r.File.RelativePath = "index.md") | ||
|
|
||
| // Test that the file has the correct applies_to information | ||
| test <@ defaultFile.File.YamlFrontMatter <> null @> | ||
| match defaultFile.File.YamlFrontMatter with | ||
| | NonNull yamlFrontMatter -> | ||
| test <@ yamlFrontMatter.AppliesTo <> null @> | ||
| match yamlFrontMatter.AppliesTo with | ||
| | NonNull appliesTo -> | ||
| // Verify stack applies_to | ||
| match appliesTo.Stack with | ||
| | NonNull stack -> test <@ stack.Count > 0 @> | ||
| | _ -> () | ||
|
|
||
| // Verify serverless applies_to | ||
| test <@ appliesTo.Serverless <> null @> | ||
| | _ -> () | ||
| | _ -> () | ||
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot This test is useless if we cannot test the output of the frontmatter applies_to
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in commit 5a4c560. The test now directly calls
LlmAppliesToHelper.RenderAppliesToBlockto test the actual output that appears in the metadata section. The test verifies:ApplicableToobjectRenderAppliesToBlockproduces output containing "This applies to:"This tests the actual rendering logic that generates the applies_to metadata text in exported files.