Skip to content

docs: replace pre-2.0 landing-page illustration with editable SVG#164

Merged
MilagrosMarin merged 1 commit intomainfrom
docs/landing-page-illustration
May 4, 2026
Merged

docs: replace pre-2.0 landing-page illustration with editable SVG#164
MilagrosMarin merged 1 commit intomainfrom
docs/landing-page-illustration

Conversation

@dimitri-yatsenko
Copy link
Copy Markdown
Member

@dimitri-yatsenko dimitri-yatsenko commented May 4, 2026

Summary

  • Replaces src/images/pipeline.png (1 MB raster, lost source, pre-2.0 syntax) with a hand-written src/images/pipeline.svg (5 KB) on the docs landing page.
  • New illustration depicts a calcium-imaging pipeline using vocabulary already shared with calcium-pipeline.svg and explanation/computation-model.md.
  • Follows DataJoint's diagram notation: rectangles for Manual/Lookup, ovals for Imported/Computed; lighter pastel palette matching calcium-pipeline.svg.
  • Code snippet uses 2.0 syntax: int32, <blob@>, canonical make() shape.
  • Zoom-in callout from the highlighted Segmentation node to its definition is preserved, with the original pedagogical annotations updated for 2.0 (database link, table name, dependency, object-store attribute, computation).
  • The SVG is its own source — text in the repo, no separate editable asset to lose.

Test plan

  • mkdocs serve and load / — confirm the new illustration renders inline, indented code reads correctly, all five annotations resolve to the right code lines.
  • mkdocs build --strict passes.
  • Verify shape convention: Manual & Lookup are rectangles; Imported & Computed are ovals.
  • Verify code uses 2.0 type names (int32, <blob@>) and not legacy ones.
  • Spot-check at narrow viewport widths.

The hero image on the docs landing page was a 1 MB raster bundling a
diagram and a code snippet; the editable source had been lost. The
snippet used pre-2.0 type names (longblob, double).

Replace with a hand-written SVG (5 KB) that:
- depicts a calcium-imaging pipeline using the vocabulary already in
  calcium-pipeline.svg and computation-model.md
- follows DataJoint's notation: rectangles for Manual/Lookup, ovals
  for Imported/Computed, encoded by both shape and color
- uses 2.0 type syntax (int32, <blob@>) and the canonical make() form
- preserves the original zoom-in callout from the highlighted node
  to its definition, with the same pedagogical annotations
- uses the lighter pastel palette already in calcium-pipeline.svg

The SVG is its own source — committed as text, no separate editable
asset to lose.
@MilagrosMarin MilagrosMarin merged commit bf0a6d1 into main May 4, 2026
2 checks passed
@dimitri-yatsenko dimitri-yatsenko deleted the docs/landing-page-illustration branch May 5, 2026 16:01
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.

2 participants