Skip to content

Docs: represent the DataJoint book's core principles (coverage review) #225

Closed

Description

@dimitri-yatsenko

Umbrella tracking a book → docs coverage review: an audit of the core principles taught in the DataJoint book against the published documentation. Across ~37 principles in three clusters (integrity/keys, normalization, computation/reproducibility), the docs are solid overall — and stronger than the book on the make() reproducibility contract — with the gaps below.

New pages / major expansions

Targeted additions & one fix

Already addressed while this review ran

The audit baselined main, so these showed as gaps there but are closed on in-flight branches:

Where the docs already win (no action)

The make() reproducibility contract (formalized beyond the book), no-auto-increment rationale, the three questions of entity integrity, schema dimensions & lineage, cardinality-from-FK-placement, tripartite make(), and the mouse/cage normalization example.

Activity

  1. dimitri-yatsenko commented on Jul 18, 2026

    @dimitri-yatsenko
    MemberAuthor

    Progress — PRs opened for all of P1–P8:

    All three PRs are drafts pending review on the docs server. Separately, #205 (executed tripartite-make() worked example) is in progress.

  2. dimitri-yatsenko commented on Jul 21, 2026

    @dimitri-yatsenko
    MemberAuthor

    All tracked items from this coverage review are now resolved:

    Closing the umbrella.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions