Skip to content

docs(report): correct which metrics the report charts - #215

Closed
0x00101010 wants to merge 2 commits into
mainfrom
docs/docs-20261031-0300
Closed

0x00101010 wants to merge 2 commits into
mainfrom
docs/docs-20261031-0300

Conversation

@0x00101010

@0x00101010 0x00101010 commented Oct 31, 2026 •

Copy link
Copy Markdown
Collaborator

Description

Why

docs/report-data-contract.md said that metric keys missing from report/src/metricDefinitions.ts "still render, just with raw key names". ChartGrid only charts the metrics listed in CHART_CONFIG, so a producer adding a new key gets no chart and no hint why. #214 hit this: the builder validity metrics were scraped but never shown until they were added to CHART_CONFIG.

What

  • Change the claim to say the report charts only metrics listed in metricDefinitions.ts.

Notes

  • resolveMetricKey can chart one labeled variant (<listed-key>_<label>) under a listed entry's chart. One reviewer wanted that spelled out. I kept it out because the chart still belongs to the listed metric, and spelling it out would add new explanation to the doc.

Testing

Evidence

Review: ready | med, 80% | light (docs-only diff): claude-sonnet-5-5 + gpt-6-luna (reviewers split on the final wording; see Notes)

Verified How Result
Unlisted keys are not charted report/src/components/ChartGrid.tsx:45 maps only SORTED_CHART_CONFIG; no other component renders ExecutionMetrics keys old claim false, new claim holds
Labeled-variant fallback report/src/components/ChartGrid.tsx:24-38 resolves to a listed entry's chart, title and unit

ChartGrid renders only SORTED_CHART_CONFIG entries (report/src/components/ChartGrid.tsx:45).
ChartGrid can resolve a listed key to one labeled variant (report/src/components/ChartGrid.tsx:24).
@cb-heimdall

Copy link
Copy Markdown
Collaborator

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

@cb-heimdall

Copy link
Copy Markdown
Collaborator

Review Error for meyer9 @ 2026-10-31 14:58:02 UTC
User failed mfa authentication, see go/mfa-help

@0x00101010 0x00101010 closed this Oct 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants