Skip to content

docs(readme): fix stale citation; note PostgreSQL as a peer backend#232

Merged
dimitri-yatsenko merged 1 commit into
mainfrom
docs/readme-stale-fixes
Jul 21, 2026
Merged

docs(readme): fix stale citation; note PostgreSQL as a peer backend#232
dimitri-yatsenko merged 1 commit into
mainfrom
docs/readme-stale-fixes

Conversation

@dimitri-yatsenko

Copy link
Copy Markdown
Member

Two stale items in the top-level README.md:

  1. Citation was wrong. It cited "DataJoint: A Simpler Relational Data Model. arXiv:2303.00102. 2023" — an arXiv id that matches nothing in src/about/citation.md (the "simpler relational data model" paper is arXiv:1807.11104/2018). Replaced with the current canonical DataJoint 2.0 citation the docs designate for 2.0 / the Relational Workflow Model: Yatsenko D, Nguyen TT. DataJoint 2.0: A Computational Substrate for Agentic Scientific Workflows. arXiv:2602.16585 (2026), incl. RRID:SCR_014543 — matching about/citation.md.
  2. PostgreSQL wasn't mentioned. The compose stack runs a postgres:15 service with MODE=EXECUTE_PG, and PostgreSQL is a peer backend — but the README said "includes MySQL, MinIO" and listed only "MySQL 8.0+". Now notes MySQL and PostgreSQL in the Docker environment and native prerequisites.

Everything else referenced in the README was verified current (pip_requirements.txt, scripts/check_notebook_versions.py, the compose MODE options, Diátaxis links).

Docs-only, top-level README.

- Citation pointed at a non-existent arXiv id (2303.00102/2023); replace with the
  current canonical DataJoint 2.0 manuscript (arXiv:2602.16585, 2026) per
  about/citation.md, incl. RRID.
- README listed only MySQL; the compose stack now runs PostgreSQL (postgres:15,
  MODE=EXECUTE_PG) and PostgreSQL is a peer backend — note it in the Docker
  environment and native prerequisites.
@dimitri-yatsenko dimitri-yatsenko added the documentation Improvements or additions to documentation label Jul 20, 2026
@dimitri-yatsenko
dimitri-yatsenko merged commit e619533 into main Jul 21, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants