Skip to content

Commit

Permalink
Stub out custom metrics docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rviscomi committed Dec 7, 2023
1 parent 255eccd commit 0c2f1ee
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 2 deletions.
4 changes: 4 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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' }
Expand Down
12 changes: 12 additions & 0 deletions src/content/docs/reference/custom-metrics/performance.mdx
Original file line number Diff line number Diff line change
@@ -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
16 changes: 16 additions & 0 deletions src/content/docs/reference/structs/custom-metrics.mdx
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 4 additions & 2 deletions src/content/docs/reference/tables/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand All @@ -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.
See the [`metadata`](/reference/blobs/page-metdata/) reference for more details.

0 comments on commit 0c2f1ee

Please sign in to comment.