Skip to content

Docs: Python workbench coverage + screenshots, em-dash purge, clinical-stack cross-links#81

Merged
tgerke merged 3 commits into
mainfrom
docs/style-and-python-refresh
Jul 14, 2026
Merged

Docs: Python workbench coverage + screenshots, em-dash purge, clinical-stack cross-links#81
tgerke merged 3 commits into
mainfrom
docs/style-and-python-refresh

Conversation

@tgerke

@tgerke tgerke commented Jul 13, 2026

Copy link
Copy Markdown
Owner

Stacked on #79 (targets infra/single-vm-deployment; retarget to main after #79 merges — the diff should then show only the three docs commits).

What

Three passes over the user-facing docs (site/*.qmd, guide pages, README):

  1. Python workbench coverage. The workbench has had a third SQL/R/Python tab since Python workbench sidecar (#65) #71, but index.qmd's analytics bullet said "real SQL and real R" and the tour only mentioned the R tab. Fixed both, and analytics.qmd now shows the Python tab.
  2. Screenshot refresh. workbench-sql.png and workbench-r.png predated the Python tab (two-tab bar, old page copy); both re-shot, plus a new workbench-python.png (pandas describe() output, result grid, language badges in the execution history). Captured from a fresh demo seed on the current images at the same 1440pt@2x full-page framing as the v0.3.0 refresh. The other screenshots depict pages unchanged since that refresh (verified by diffing apps/web/src/pages against the refresh commit; the one exception, MatrixPage, renders identically for an unblinded study — a re-shot came out byte-identical).
  3. Writing pass. Em dashes were the docs' dominant tic (8–24 per page, up to one every 42 words in compliance.qmd); now at most one per page, replaced with colons, semicolons, parentheses, or sentence breaks. One negation-pivot cliché in review.qmd rewritten. Regulatory citations were restructured only around punctuation; the single rephrased claim (E6(R3) audit-trail review, review.qmd) was re-grounded against §4.2.3 of the guideline text.

Also adds the cross-link the repo split implied but never made: installation.qmd and the README now point co-installs (edc-core + ctms-core, shared Keycloak/Caddy/Postgres) at clinical-stack, which already links back here for single-app installs.

Verification

  • quarto render site/ clean (14 pages).
  • Rendered analytics page references the new screenshot; zero em dashes in rendered prose (the two remaining in README sit inside the ASCII architecture diagram).
  • All three workbench captures visually inspected: three tabs, updated page copy, executed results.

tgerke added 3 commits July 13, 2026 08:43
…stack

- index.qmd's analytics bullet said SQL and R only; the tour never mentioned
  the Python tab. Both now match the three-tab workbench that shipped in #71.
- analytics.qmd gains the Python workbench screenshot slot (image lands with
  the screenshot refresh).
- installation.qmd and README point co-installs (edc-core + ctms-core, shared
  Keycloak/Caddy/Postgres) at the clinical-stack repo, which already links
  back here for single-app installs.
Applied the avoid-ai-writing pass: em dashes (previously 8-24 per page)
replaced with colons, semicolons, parentheses, or sentence breaks; the
one negation-pivot cliche in review.qmd rewritten. Regulatory citations
untouched except punctuation; the one rephrased E6(R3) claim (audit-trail
review) re-grounded against the source text (§4.2.3).
…-python

workbench-sql/r predated the third tab (#71): both showed a two-tab bar and
the old 'SQL and R' page copy. Re-shot all three against a fresh v0.4.0-image
demo seed, plus a new workbench-python.png (pandas describe + result grid,
language badges in the execution history). subject-matrix re-shot from the
same stack; MatrixPage changed since the last refresh (#74) but renders
identically for an unblinded study. The other 13 screenshots depict pages
untouched since the v0.3.0 refresh and are kept.
@tgerke
tgerke changed the base branch from infra/single-vm-deployment to main July 14, 2026 18:13
@tgerke
tgerke merged commit bbe5f99 into main Jul 14, 2026
1 check passed
@tgerke
tgerke deleted the docs/style-and-python-refresh branch July 14, 2026 18:14
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