docs: refresh README pipeline illustration#1448
Conversation
Replace the pre-2.0 pipeline illustration in the README with the new landing-page asset from datajoint-docs. The previous PNG bundled a diagram and a code snippet using legacy type names (longblob, double) and was rendered from a now-stale .drawio source. - Add images/pipeline.svg as the editable source of truth (text in the repo — no separate file to lose). - Re-render images/pipeline.png from the SVG so the existing README image link continues to work without changes (GitHub raw SVGs serve as text/plain and don't render inline; PNG remains the safer choice for README display). - Remove images/pipeline.drawio — superseded by the SVG, no longer the source of truth. The new illustration uses calcium-imaging vocabulary that matches the docs (Subject/Session/Scan/AverageFrame/Segmentation/Activity), follows DataJoint's notation (rectangles for Manual/Lookup, ovals for Imported/Computed), and shows 2.0 type syntax (int32, <blob@>).
|
@dimitri-yatsenko, thanks for this PR. I have a couple of comments: (1) It seems the new image is much smaller than the previous one. Can you confirm it is visible and clear, with a font size of approximately 9-11 points? (2) In addition, I see that the comments on the right are set against a transparent background, while the make function text has a white background. This can be an issue if the background turns black, since the text is black too. Could these comments be set against a white background as well? |
Address review feedback on the new landing-page illustration: - Add an opaque white background rect covering the full viewBox so the entire illustration (annotations included) reads correctly against any page theme. Previously the code panel had its own white rect but the surrounding annotations sat on transparent — black text on a black page background made them invisible in GitHub's dark-mode README rendering. - Bump the annotation font size from 17 to 19 to keep effective rendered text in the 9-11pt range when displayed at typical README column widths. Re-render images/pipeline.png from the updated SVG.
|
Thanks for the careful review, @MilagrosMarin — both points were on the money. Pushed db98bfa to address them:
Re-rendered |
Summary
images/pipeline.svgas the editable source of truth — text in the repo, so the source can't go missing again.images/pipeline.pngfrom the SVG so the README's existing raw-URL image link keeps working without edits. (GitHub serves raw.svgastext/plain, which doesn't render inline; PNG stays the safer display format for README.)images/pipeline.drawio— the stale source for the old PNG, now superseded by the SVG.The new illustration uses calcium-imaging vocabulary matching the docs (
Subject→Session→Scan→AverageFrame→Segmentation→Activity), follows DataJoint's notation (rectangles for Manual/Lookup, ovals for Imported/Computed), and shows 2.0 type syntax (int32,<blob@>).Test plan
int32and<blob@>, notlongblob/double.pipeline.drawio(verified via grep at commit time).