diff --git a/workflows/shared/formatting.md b/workflows/shared/formatting.md new file mode 100644 index 0000000..75700fe --- /dev/null +++ b/workflows/shared/formatting.md @@ -0,0 +1,38 @@ +--- +# Shared content formatting fragment — imported by other fragments +--- + +## Content Structure + +Structure your output with an overview followed by detailed content: + +1. **Content Overview**: Start with 1-2 paragraphs that summarize the key findings, highlights, or main points of your report. This should give readers a quick understanding of what the report contains without needing to expand the details. + +2. **Detailed Content**: Place the rest of your report inside HTML `
` and `` tags to allow readers to expand and view the full information. **IMPORTANT**: Always wrap the summary text in `` tags to make it bold. + +**Example format:** + +`````markdown +Brief overview paragraph 1 introducing the report and its main findings. + +Optional overview paragraph 2 with additional context or highlights. + +
+Full Report Details + +## Detailed Analysis + +Full report content with all sections, tables, and detailed information goes here. + +### Section 1 +[Content] + +### Section 2 +[Content] + +
+````` + +## Footer Attribution + +**Do NOT add footer lines** like `> AI generated by...` to your comment. The system automatically appends attribution after your content to prevent duplicates. diff --git a/workflows/shared/reporting.md b/workflows/shared/reporting.md index c81c58d..d326c80 100644 --- a/workflows/shared/reporting.md +++ b/workflows/shared/reporting.md @@ -1,37 +1,11 @@ --- -# No frontmatter configuration needed - this is a pure instructions file +imports: + - shared/formatting.md --- ## Report Formatting -Structure your report with an overview followed by detailed content: - -1. **Content Overview**: Start with 1-2 paragraphs that summarize the key findings, highlights, or main points of your report. This should give readers a quick understanding of what the report contains without needing to expand the details. - -2. **Detailed Content**: Place the rest of your report inside HTML `
` and `` tags to allow readers to expand and view the full information. **IMPORTANT**: Always wrap the summary text in `` tags to make it bold. - -**Example format:** - -`````markdown -Brief overview paragraph 1 introducing the report and its main findings. - -Optional overview paragraph 2 with additional context or highlights. - -
-Full Report Details - -## Detailed Analysis - -Full report content with all sections, tables, and detailed information goes here. - -### Section 1 -[Content] - -### Section 2 -[Content] - -
-````` +Follow the content structure and formatting guidelines from the imported formatting fragment above. ## Reporting Workflow Run Information @@ -74,7 +48,3 @@ When your analysis is based on information mined from one or more workflow runs, - Choose the most relevant or representative runs (e.g., failed runs, high-cost runs, or runs with significant findings) - Always use the actual URL from the workflow run data (specifically, use the `url` field from `RunData` or the `RunURL` field from `ErrorSummary`) - If analyzing more than 3 runs, select the most important ones for references - -## Footer Attribution - -**Do NOT add footer lines** like `> AI generated by...` to your comment. The system automatically appends attribution after your content to prevent duplicates.