Skip to content

Add critical evaluation report of the website tutorials - #80

Open
pedroliman wants to merge 14 commits into
mainfrom
claude/tutorial-evaluation-report-01sllf
Open

Add critical evaluation report of the website tutorials#80
pedroliman wants to merge 14 commits into
mainfrom
claude/tutorial-evaluation-report-01sllf

Conversation

@pedroliman

Copy link
Copy Markdown
Owner

What this adds

A critical evaluation of the website tutorials, written from the perspective of the target reader (a health economics and outcomes research modeler at the graduate level or beyond), under devdocs/tutorial-evaluation/.

Approach

  • One evaluation per tutorial (eval-<name>.md), each judging the page on purpose and audience fit, pedagogy and concept introduction, writing against devdocs/guidance/writing_style.md, correctness (numbers re-run against the installed package), and where the page sits in the sequence.
  • An overall report (README.md) that synthesizes the per-tutorial findings and adds the cross-cutting analysis that only surfaces when the pages are read as a set: where a concept is introduced relative to where it is first used, whether the pages link into a coherent path, and where they repeat or contradict each other.

Headline cross-cutting findings

  • The "Next:" forward links contradict the sidebar reading order and leave the compartmental model and value-of-information pages with no forward link.
  • Value of information (EVPI, EVPPI) is interpreted in six tutorials before the tutorial that defines it.
  • The getting-started section opens with data plumbing rather than a model built on one of the engines.
  • The replication gallery states that each replication extends to a probabilistic analysis, which holds for only two of its four pages.

Status

Work in progress. The overall report and several per-tutorial evaluations are in; the remaining per-tutorial files are being committed as the reviews finish, and the verdict table and a correction note are updated as they land.


Generated by Claude Code

@codecov

codecov Bot commented Jul 19, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.39%. Comparing base (3024677) to head (048148c).
⚠️ Report is 21 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #80   +/-   ##
=======================================
  Coverage   95.39%   95.39%           
=======================================
  Files          40       40           
  Lines        1955     1955           
=======================================
  Hits         1865     1865           
  Misses         90       90           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

1 participant