Skip to content

docs: refresh Platform architecture diagram#179

Merged
dimitri-yatsenko merged 1 commit into
mainfrom
docs/refresh-platform-diagram
Jun 1, 2026
Merged

docs: refresh Platform architecture diagram#179
dimitri-yatsenko merged 1 commit into
mainfrom
docs/refresh-platform-diagram

Conversation

@dimitri-yatsenko
Copy link
Copy Markdown
Member

Summary

  • Replace src/images/dj-platform.png with an updated SVG showing the open-source core (relational database, code repo, object store) inside a DataJoint Platform frame, with surrounding services labeled explicitly. SVG is ~10 KB vs the previous 160 KB PNG and scales cleanly.
  • Adapted from a 2026-04 slide-deck source for use in the conceptual explanation/data-pipelines.md page:
    • AI bar labeled "AI Interface" (was "AI Interface (MCP)" in the slide — protocol-agnostic in the docs).
    • Bottom band reworded from governance/compliance language to generic pipeline qualities: "Reproducibility · Provenance · Integrity · Collaboration".
  • Light prose revision in data-pipelines.md to make the open-source-core vs. Platform layering explicit; relabel the core-component table header to "Open-Source Core".
  • Delete the now-unused dj-platform.png.

Test plan

  • MODE="LIVE" docker compose up --build (or local mkdocs serve) and open /explanation/data-pipelines/ — confirm the new SVG renders crisply, the "AI Interface" label and reworded band are visible, and the surrounding prose/table read correctly.
  • Confirm no other doc page references dj-platform.png (search): grep -rn "dj-platform" src.

Replace the radial dj-platform.png with an updated SVG showing the
open-source core (relational database + code repo + object store)
inside a DataJoint Platform frame, with surrounding services labeled
explicitly. Switching to SVG keeps the asset small (~10KB vs 160KB)
and scales cleanly at any zoom level.

Adapted for the conceptual data-pipelines page:
- AI bar labeled "AI Interface" (protocol-agnostic, was "(MCP)" in the
  source slide deck) — keeps the doc durable across protocol choices
- Bottom band reworded from governance/compliance language
  ("Governed Execution / Access Control / Audit Logging / Provenance")
  to generic pipeline qualities
  ("Reproducibility / Provenance / Integrity / Collaboration"),
  which fits a pipelines architecture overview rather than a Platform
  product pitch

Also lightly revise the surrounding prose to make the
open-source-core vs. Platform layering explicit, and relabel the
core-component table header to "Open-Source Core".

Delete the now-unused dj-platform.png.
@dimitri-yatsenko dimitri-yatsenko merged commit 82cbf9f into main Jun 1, 2026
2 checks passed
@dimitri-yatsenko dimitri-yatsenko deleted the docs/refresh-platform-diagram branch June 1, 2026 18:18
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