From 5bc974afe49ee4d65e463cab9abf1e98e3e8e684 Mon Sep 17 00:00:00 2001 From: Owen Mansel-Chan Date: Wed, 18 Jun 2025 23:59:04 +0100 Subject: [PATCH] Address review comments --- docs/query-help-style-guide.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/query-help-style-guide.md b/docs/query-help-style-guide.md index 45cac9c7e0b..3ed9f439490 100644 --- a/docs/query-help-style-guide.md +++ b/docs/query-help-style-guide.md @@ -24,13 +24,19 @@ Query help files can be written in either a custom XML format (with a `.qhelp` e #### Markdown query help files -A Markdown query help file should use the following structure and section order: +A Markdown query help file should use the following structure and section order (note that the `Implementation notes` section is optional): -1. **Overview** (level 2 heading, `## Overview`) -2. **Recommendation** (level 2 heading, `## Recommendation`) -3. **Example** (level 2 heading, `## Example`) -4. **Implementation notes** (optional, level 2 heading, `## Implementation notes`) -5. **References** (level 2 heading, `## References`) +``` +## Overview + +## Recommendation + +## Example + +## Implementation notes + +## References +``` Each section should be clearly marked with the appropriate heading. See the other Markdown files in this repository for examples. @@ -147,6 +153,7 @@ More information on how to test your query help files can be found [within the d 1. The XML format allows for the contents of other files to be included in the output generated by processing the file, as mentioned in the section `Code examples`. This is not possible with the Markdown format. 2. When using the XML format, references are added to the output HTML file based on CWE tags, as mentioned in the section `Referencing potential security weaknesses`. +3. For custom queries and custom query packs, only the Markdown format is supported. ## Query help example