From 0c2f1ee3d380a9fd6168e2535fde8317fe6129c2 Mon Sep 17 00:00:00 2001 From: Rick Viscomi Date: Thu, 7 Dec 2023 11:22:38 -0500 Subject: [PATCH] Stub out custom metrics docs --- astro.config.mjs | 4 ++++ .../reference/custom-metrics/performance.mdx | 12 ++++++++++++ .../docs/reference/structs/custom-metrics.mdx | 16 ++++++++++++++++ src/content/docs/reference/tables/pages.mdx | 6 ++++-- 4 files changed, 36 insertions(+), 2 deletions(-) create mode 100644 src/content/docs/reference/custom-metrics/performance.mdx create mode 100644 src/content/docs/reference/structs/custom-metrics.mdx diff --git a/astro.config.mjs b/astro.config.mjs index e479a0b..64e9407 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -53,6 +53,10 @@ export default defineConfig({ label: 'Blobs', autogenerate: { directory: 'reference/blobs' } }, + { + label: 'Custom Metrics', + autogenerate: { directory: 'reference/custom-metrics' } + }, { label: 'Functions', autogenerate: { directory: 'reference/functions' } diff --git a/src/content/docs/reference/custom-metrics/performance.mdx b/src/content/docs/reference/custom-metrics/performance.mdx new file mode 100644 index 0000000..ebb27f5 --- /dev/null +++ b/src/content/docs/reference/custom-metrics/performance.mdx @@ -0,0 +1,12 @@ +--- +title: Performance custom metric +description: Reference docs for the feature struct +--- + +_Appears in: [`custom_metrics` struct](/reference/structs/custom-metrics/)_ + +TODO + +## Schema + +TODO diff --git a/src/content/docs/reference/structs/custom-metrics.mdx b/src/content/docs/reference/structs/custom-metrics.mdx new file mode 100644 index 0000000..ec015a1 --- /dev/null +++ b/src/content/docs/reference/structs/custom-metrics.mdx @@ -0,0 +1,16 @@ +--- +title: Custom metrics struct +description: Reference docs for the custom metrics struct +--- + +_Appears in: [`pages` table](/reference/tables/pages/)_ + +TODO + +## Schema + +TODO + +### performance + +See the [`performance` custom metric](/reference/custom-metrics/performance/) for more information. diff --git a/src/content/docs/reference/tables/pages.mdx b/src/content/docs/reference/tables/pages.mdx index c8e91f0..3aa0a5a 100644 --- a/src/content/docs/reference/tables/pages.mdx +++ b/src/content/docs/reference/tables/pages.mdx @@ -131,7 +131,9 @@ JSON-encoded summarization of the page-level data ### `custom_metrics` -JSON-encoded test results of the custom metrics +JSON-encoded test results of the custom metrics. + +See the [`custom metrics`](/reference/structs/custom-metrics/) reference for more details. ### `lighthouse` @@ -153,4 +155,4 @@ See the [`technology`](/reference/structs/technology/) reference for more detail Additional metadata about the test -See the [`metadata`](/reference/blobs/page-metdata/) reference for more details. \ No newline at end of file +See the [`metadata`](/reference/blobs/page-metdata/) reference for more details.