Expand user documentation: role-based navigation, five new guide pages, full screenshot coverage#96
Merged
Merged
Conversation
…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.
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.
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)
Screenshots (426e00d)
scripts/screenshots.mjsnow 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.apps/api/Dockerfilenever copiedpackages/usdm, so the containerized API has failed to boot since the USDM import landed (ERR_MODULE_NOT_FOUNDon@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.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:
ST.AMD.DEMOstate, the two deliberate rules, ripple effects, and what the evidence trail looks like to an inspector.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 siteclean; every image reference resolves and every image is referenced (zero orphans); scripted check confirms all internal links in_siteresolve.pnpm screenshotsrun from a fresh stack passes end to end, including the new states, and is idempotent on re-run.