proposal: new documentation comment to mark important docs for LLMs

[Meir017]

Allow documentation comments to add a new tag (ex: <llm/>) to help finding the important docs for LLMs.

The reasoning for this is that many codebases already have high-quality docs as xml comments and creating something brand (such as https://llmstxt.org/) new would cause duplication.

By marking documentation comments as relevant for LLM's we would be able to easily generate a comprehensive guide for LLM's by cralwing over the source code and extracting all interesting comments and public API's into a single file for LLM's to consume (or something like https://dotnet.github.io/docfx/ would support this)

[TahirAhmadov]

Why can't this crawler use existing comments, and then LLM can be instructed to interpret them according to what C#'s comment rules state? I'm not sure what this tag would solve, what would it contain, etc.

[Meir017]

My concern is that crawing over the entire public API and comments of large libraries might be too much context for an LLM to summarize, so I need to remove some of the non-critical API's

[jnm2]

I can't remember, does anything prevent this tag from already being put to use? Does the language need to do anything?

[TahirAhmadov]

I think it's less effort to play around with LLM instructions, crawler rules, etc., than to introduce a new tag (be it part of the language or not) and then have library authors re-type a whole bunch of stuff for LLM's sake.

[jnm2]

My point is mainly, what's stopping someone from introducing a new tag? What is there for the language to do here?