Skip to content

Expand user documentation: role-based navigation, five new guide pages, full screenshot coverage#96

Merged
tgerke merged 3 commits into
mainfrom
docs/full-coverage
Jul 18, 2026
Merged

Expand user documentation: role-based navigation, five new guide pages, full screenshot coverage#96
tgerke merged 3 commits into
mainfrom
docs/full-coverage

Conversation

@tgerke

@tgerke tgerke commented Jul 18, 2026

Copy link
Copy Markdown
Owner

Full pass over the user-facing docs: coverage for every shipped feature, role-based entry points, and screenshots for the pages that lacked them. Three commits, one per unit of work.

Navigation and orientation (f333a13)

  • New Start here page with four reading tracks (entry-level data managers, study builders, CRO/sponsor leadership, clinical operations), each mapped to a demo persona so readers can follow along in a seeded stack.
  • New Glossary (~40 terms, plain language, each linked to the page that treats it). Part 11 and ICH E6(R3) entries are descriptive only and checked against the source texts.
  • Sidebar reorganized into sections (Building studies / Capturing data / Review and oversight / Analytics and exports / Reference). No URLs or heading anchors changed.
  • Index gains a "Start here by role" table.

Screenshots (426e00d)

  • scripts/screenshots.mjs now builds five more reference states (amendment demo study with a v2 build awaiting migration, blinded dosing study with the arm delivered through the RTSM intake via a minted API key, USDM protocol import left unpublished, a manual query, draft + submitted site layouts, a lab-import mapping) and captures 16 new shots. The two rules-panel shots are element crops; everything else stays full-page.
  • All 19 existing shots regenerated from a fresh stack alongside the new ones, per the CONTRIBUTING recipe (updated).
  • Bug fix that this surfaced: apps/api/Dockerfile never copied packages/usdm, so the containerized API has failed to boot since the USDM import landed (ERR_MODULE_NOT_FOUND on @edc-core/usdm). Fixed here because the capture run needs the compose stack; happy to split it out if you'd rather it land separately.
  • One behavior note found along the way, filed separately rather than fixed here: the subject matrix gates lifecycle/unblind menus on study-scope permissions, so site-scoped coordinators and investigators never see them. The break-blind and subject-lifecycle shots use demo-admin for that reason.

New and expanded guide pages (e2d2ee5)

New pages, each promoting thin sections that were scattered across other pages into a full walkthrough against the seeded demo data:

  • Rules and derivations — edit checks vs skip logic vs derivations, a JSONata primer using the demo study's actual expressions, authoring walkthroughs with the live syntax checker.
  • Mid-study amendments — the diff → impact → execute cycle on the seeded ST.AMD.DEMO state, the two deliberate rules, ripple effects, and what the evidence trail looks like to an inspector.
  • Blinding — what each role sees on the same form, where the mask follows, break-the-blind, governance.
  • Notifications — event-to-recipient map, the deliberate silences, overdue reminders, why it matters for query aging.
  • Exports, casebooks, and the study archive — the three export formats and when to use which, casebooks, the archive as the exit path, and the first user-facing description of eTMF filing.

Existing pages: the promoted sections shrink to summaries with links (anchors preserved); site-forms, protocol-import, lab-import, rtsm-integration, and data-capture gain screenshots and worked examples; review.qmd now documents the OIDC re-authentication path at signing, which was previously undocumented; the tour links each step to its full guide page.

Verification

  • quarto render site clean; every image reference resolves and every image is referenced (zero orphans); scripted check confirms all internal links in _site resolve.
  • Every new PNG visually checked for the intended UI state.
  • Regulatory attributions in new prose (E6(R3) §4.1.4, §4.2.7, Part 11 scope) checked against the local source mirror.
  • Full pnpm screenshots run from a fresh stack passes end to end, including the new states, and is idempotent on re-run.

tgerke added 3 commits July 18, 2026 13:26
…file

The api image was missing packages/usdm, so the containerized API failed
to boot since the USDM import landed. New screenshot states: amendment,
blinded-dosing, and USDM protocol demo studies, a manual query, site
layouts, and a lab-import mapping. All existing shots regenerated from a
fresh stack alongside the new ones.
…xports

Promotes thin sections scattered across existing pages into dedicated
walkthroughs with screenshots, shrinks the originals to summaries with
links, wires the new pages into the sidebar and role tracks, and adds
per-step guide links to the tour.
@tgerke
tgerke merged commit 768199e into main Jul 18, 2026
1 check failed
@tgerke
tgerke deleted the docs/full-coverage branch July 18, 2026 21:31
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