Automatically Generate Documentation for Queries in Query Library Based on their YAML

[oreenlivnicode]

Problem Statement

Currently, every query in our query library is associated with a YAML file. This file outlines essential details like the query's function, parameters, references, etc. Additionally, we have more comprehensive documentation for these queries and exploits in the docs folder.

Creating markdown documentation can be a time-consuming task. While we don't want this to discourage contributions, all queries must be documented. Therefore, we must balance accessibility for contributors with the necessity for thorough documentation.

Proposed Solution

Automate the generation of Markdown documentation for each query in the query library based on its YAML file. This should be triggered on each new release to ensure the documentation is always up-to-date with the latest queries.

Technical Details

Event Trigger:
New GitHub push/ push to query library/ release

Process:
Read the YAML files of the queries in the query library.
Use a predefined Markdown template.
Unpack the YAML data into the Markdown template.
Save the new Markdown files in a documentation directory.

We can possibly do it with a github action.

What do you think?