Skip to content

Patch missing pages in the documentation #1198

Description

@kushalbakshi

Problem:

The current documentation is missing information about several DataJoint features. The pages state Coming Soon and do not have any information.

Solution: Captured in PR #1197.

The following content needs to be added for the documentation to be considered current and complete. These will be marked as complete when information has been added to the PR prior to review. The issue will be closed when the PR is merged. Resolution of this issue will also close #1157.

  • client/stores.md
  • design/alter.md
  • design/tables/blobs.md
  • design/tables/customtype.md
  • design/tables/indexes.md
  • design/tables/attributes.md - add hidden attributes
  • internal/transpilation.md
  • Verify FAQ page: Interfaces section
  • Add information about DataJoint base docker images
  • Document dj.Top

Activity

  1. added
    staleIndicates issues, pull requests, or discussions are inactive
    on Mar 14, 2025
  2. removed
    staleIndicates issues, pull requests, or discussions are inactive
    on Jan 9, 2026
  3. added this to the DataJoint 2.0 milestone on Jan 9, 2026
  4. dimitri-yatsenko commented on Jan 9, 2026

    @dimitri-yatsenko
    Member

    Documentation Status

    The datajoint-docs repository has been comprehensively rewritten using the Diataxis framework. All checklist items are now addressed:

    Original Item Status New Location
    client/stores.md ✅ Complete how-to/configure-storage.md
    design/tables/customtype.md ✅ Complete how-to/create-custom-codec.md
    design/tables/indexes.md ✅ Complete reference/definition-syntax.md, reference/specs/table-declaration.md §7
    attributes.md - hidden attributes ✅ Complete reference/specs/job-metadata.md
    internal/transpilation.md N/A Internal implementation detail, not user-facing documentation
    FAQ page: Interfaces N/A New Diataxis structure uses how-to guides instead of FAQ
    DataJoint base docker images N/A DataJoint no longer provides base Docker images—infrastructure provisioning is outside the scope of the library
    Document dj.Top ✅ Complete reference/specs/query-algebra.md §12

    The "Coming Soon" placeholders referenced in this issue no longer exist. All documentation is now substantive content organized by Diataxis categories (tutorials, how-to, reference, explanation).

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

Metadata

Metadata

Labels

enhancementIndicates new improvements

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions