Skip to content

Commit 769f75a

Browse files
committed
move comment into markdown.ts
1 parent 68271bd commit 769f75a

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

.github/scripts/analyze_benchmarks/markdown.ts

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,24 @@ export async function generateMarkdownReport(): Promise<string> {
1616
})
1717
);
1818

19-
return `# Benchmarks
19+
return `<!--
20+
This file is auto-generated by .github/scripts/analyze_benchmarks/markdown.ts
21+
Do not edit this file manually. Changes will be overwritten.
22+
-->
23+
24+
# Benchmarks
25+
26+
## Purpose and Usage
27+
28+
This document tracks high-level performance changes across Azle versions for comparison between releases.
29+
30+
**For detailed benchmarks showing how different Candid data types perform, see the [benchmarks example](examples/stable/test/end_to_end/candid_rpc/benchmarks/benchmarks.md).** This is the best resource for understanding day-to-day performance in your Azle applications.
2031
2132
${generateVersionTables(sortedBenchmarks)}
2233
2334
---
24-
*Report generated automatically by Azle*`;
35+
36+
_Report generated automatically by Azle_`;
2537
}
2638

2739
function generateVersionTables(

0 commit comments

Comments
 (0)