Skip to content

docs: fix stale test count + dashboard route path (BEN-54)#57

Open
benSepanski wants to merge 1 commit intomainfrom
claude/nifty-bardeen-c2jbC
Open

docs: fix stale test count + dashboard route path (BEN-54)#57
benSepanski wants to merge 1 commit intomainfrom
claude/nifty-bardeen-c2jbC

Conversation

@benSepanski
Copy link
Copy Markdown
Owner

Context

Doc-review pass for BEN-54. Found two factual inaccuracies that send readers
to wrong information: a stale gate-status test count and a wrong dashboard
route in two places.

TL;DR

Update PROGRESS.md test count 110 → 151 and fix #/run/<id> to
#/runs/<id> in the FRONTEND and live-dashboard docs.

Summary

  • PROGRESS.md: gate-status line said 110 unit tests + 5 eval scenarios; running pnpm all today reports 151 + 5. Updated.
  • docs/FRONTEND.md and docs/product-specs/live-dashboard.md: route table + reviewer journey listed #/run/<id>, but src/web/App.tsx parses runs/ (plural) and src/web/Dashboard.tsx links to #/runs/${r.id}. Docs now match the code.
  • Tables reflowed by Prettier; no other content changes.

Demo

n/a — docs-only edits, no user-visible surface.

Alternatives

  • Bigger doc-gardening pass (regrade docs/QUALITY_SCORE.md, refresh _Last reviewed_ stamps, audit every cross-link). Rejected: out of scope for a single cron tick — the existing tech-debt-tracker.md already tracks the proposed doc-gardening eval that should automate this. Filing additional fixes belongs in a follow-up ticket.
  • Leave the route docs and "fix" the code instead (rename runs/run/). Rejected: #/runs/<id> is consistent with /api/runs/:id and is what the live UI links to today; renaming would break every existing bookmark + transcript link.

Test Plan

  • pnpm all — typecheck + fmt:check + lint + test (151) + eval (5)
  • pnpm build:web — not run; touched no code, no bundle impact
  • Manual: grep -rn '#/run/' docs/ src/ returns nothing after the fix.

Generated by Claude Code

PROGRESS.md said `110 unit tests + 5 eval scenarios`; the suite is at
151 + 5 today. FRONTEND.md and product-specs/live-dashboard.md
both documented the run-detail route as `#/run/<id>`, but
`src/web/App.tsx` parses `runs/` (plural) and `Dashboard.tsx`
links there — so the docs sent reviewers to a 404.
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.

2 participants