show the utils file in the samples page to clarify what the functions…

… do (#9160)
chartjs · May 26, 2021 · 140cbb4 · 140cbb4
1 parent 03eb826
commit 140cbb4
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -264,6 +264,7 @@ module.exports = {
             'plugins/quadrants',
           ]
         },
+        'utils'
       ],
       '/': [
         '',

diff --git a/docs/samples/utils.md b/docs/samples/utils.md
@@ -0,0 +1,14 @@
+# Utils
+
+## Disclaimer
+The Utils file contains multiple helper functions that the chart.js sample pages use to generate charts.
+These functions are subject to change, including but not limited to breaking changes without prior notice.
+
+Because of this please don't rely on this file in production environments.
+
+## Functions
+
+<<< @/docs/scripts/utils.js
+
+[File on github](https://github.com/chartjs/Chart.js/blob/master/docs/scripts/utils.js)
+