docs: add Factory Dashboard metrics reference (APP-5546) - #582
Draft
warp-agent-staging[bot] wants to merge 2 commits into
Draft
docs: add Factory Dashboard metrics reference (APP-5546)#582warp-agent-staging[bot] wants to merge 2 commits into
warp-agent-staging[bot] wants to merge 2 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Author
|
This PR was generated with Warp. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



Summary
Adds a dedicated metrics reference page for the Factory Dashboard, so the per-metric detail that used to live only in on-hover tooltips (APP-5546) has a durable home in the docs. This is the docs half of APP-5546; the companion client change is warpdotdev/warp-server#15643, which trims the Dashboard's info tooltips and adds a visible link to this page.
Related issues
Linear APP-5546 — "Add metrics page documentation"
Changes
src/content/docs/factories/metrics-reference.mdx: a reference page covering every metric on the factory Dashboard — Total runs (including its breakdown views and their per-view counting rules, e.g. the By-model cap-at-eight-plus-Other fold and the Unknown bucket), Pull requests (opened and merged, and the direction and cause of their occasional mismatch), Autonomy, Cycle time (all four stages), Cost per PR (cost-breakdown and by-PR-size views, including all three of that view's empty/partial/full footnote states), Most expensive PRs (naming exactly which columns are backed by webhook PR facts versus by the run itself), and Scorer cards — what each counts, how it's computed (median semantics, cohort/merge-time counting, the even cost split across a run tree's PRs), its data-source coverage limits, and how to read it without drawing the wrong conclusion. Also clarifies that Self-improvement pull requests live on their own page, not as a Dashboard card.src/sidebar.tsunder Factories > Management & observability, after Measure and improve.src/content/docs/factories/measure-and-improve.mdx's per-metric table into a short summary that links to the new reference, so detail is single-sourced.src/content/docs/factories/factory-dashboard.mdx's Read metrics on the Dashboard page section the same way, and added the reference to its Next steps list.Per requirement 10c/15a in
warp-server'sspecs/factory-metrics/PRODUCT.md, the Time saved card was removed from the dashboard before this docs pass, so it is intentionally not documented as a shipped metric.Every claim about which fields are backed by webhook-collected PR facts versus by the run/agent-config metadata itself was verified directly against
TopPRsTable.tsx,CostPerPRCard.tsx,RunBreakdownCard.tsx, andrun-breakdown.tsin the shipping client, not inferred from the spec alone — the spec and the UI diverge in a few places (e.g. Creator/Source/requested-Model in Most expensive PRs come from the run's root-run metadata, not from PR facts).Validation
npm install && npm run build— full Astro Starlight build succeeds, including the new page (dist/client/factories/metrics-reference/index.html).python3 .agents/skills/style_lint/style_lint.py --changed— 0 errors; 39 warnings, all pre-existingunrecognized-termnotices on bolded UI terms already used across the touched files (e.g. "Dashboard", "Runs", "Secrets", "Unknown", "Other"), none introduced by the new content.python3 .agents/skills/check_for_broken_links/check_links.py --internal-only— 378 files scanned, 3,859 internal links checked, 0 broken.Screenshots
Not applicable — text-only documentation change, no UI screenshots to capture.
Unverified claims
None — every metric definition and computation detail (median semantics, cohort vs. merge-time counting, the run-tree cost split, PR-size thresholds, autonomy's human-touch definition, cycle-time stage semantics, webhook coverage caveats, and exactly which Most-expensive-PRs columns are PR-fact-backed vs. run-metadata-backed) was verified against
warp-server'sspecs/factory-metrics/PRODUCT.mdandTECH.md, and cross-checked against the liveFactoryDashboardclient source (AutonomyCard.tsx,PRLatencyBarsCard.tsx,CostPerPRCard.tsx,RunBreakdownCard.tsx,TopPRsTable.tsx,run-breakdown.ts,metrics-utils.ts,cost-by-size.ts) and its tests.Follow-ups
https://docs.warp.dev/factories/metrics-reference/404s until this PR merges and deploys, so the server change should not roll out first. That sequencing decision is a human call, not something resolved in either PR's code.Co-Authored-By: Oz oz-agent@warp.dev