Skip to content

[Feature Request]: LLM readable applies_to #1589

@reakaleek

Description

@reakaleek

Prerequisites

  • I have searched existing issues to ensure this feature hasn't already been requested
  • I have tested using the latest version of docs-builder

What problem are you trying to solve?

In #1569 we worked on fixing the LLM readable markdown output.

However, we do not have a custom renderer for applies_to tags. This means, applies_to tags are currently just showing the yaml content.

LLMs are not able to understand the applies_to yaml content.

Proposed Solution

Create a custom LlmMarkdown renderer for the applies_to directive, role and frontmatter configurations.

Their output should be full sentences that are understandable by LLMs.

Ideas (The following text is just to illustrate and will be reworked by @florent-leborgne):

  • For the frontmatter the rendered output could be something like:

    The following points apply to the whole document:
      - This feature is available in Technical Preview in Serverless.
      - This feature is generally available in Elastic Stack 9.0
  • for the section level directive it could be something like:
    "The following section applies to etc."

  • and for inline it could be a single sentence:
    "This feature is available in Serverless Kibana projects"

Examples and Research

No response

Alternative Solutions

No response

Additional Context

This is important because the markdown output will be used by our own assistant as well.

How important is this feature to you?

Important

Metadata

Metadata

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions