Clarify DataJoint 2.0 pre-release status in installation guide #111
+18,821
−9,670
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Fixed llms.txt manual reference from migrate-from-0x to migrate-to-v20 - Regenerated llms-full.txt to pick up all corrected migration guide links from PR #107 - Verified no remaining broken internal links in LLM documentation files
Resolves contradictory version messaging identified in cohesion review: - installation.md said '2.0 in preparation' but was ambiguous - versioning.md treats 2.0 as baseline (correct) - Users confused about which version to install Changes: - Restructured installation.md with clear pre-release vs stable sections - Added decision table for version mismatch scenarios - Updated landing page (index.md) to clearly state pre-release status - Provides explicit instructions for both testing 2.0 and using stable 0.14.x - Regenerated llms-full.txt Impact: - New users can now make informed decision: test 2.0 vs use stable - Clear paths to legacy docs, migration guide, or pre-release installation - Eliminates contradiction between installation and versioning pages Fixes: COHESION-REVIEW.md Issue #2 (High Priority)
This was referenced Jan 14, 2026
Member
Author
|
Consolidated into #119 - Documentation Cohesion Review: Comprehensive Improvements for DataJoint 2.0 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Resolves contradictory version messaging that confused users about DataJoint 2.0 availability and which version to install.
Problem
From cohesion review (COHESION-REVIEW.md Issue #2):
installation.mdsaid "2.0 releases are currently in preparation" (ambiguous)versioning.mdtreats 2.0 as baseline (correct for this documentation)Changes
Restructured installation.md
Before: Single flow with confusing warnings mixed in
After: Clear sections with explicit guidance
Added decision table:
Updated landing page (index.md)
Before:
!!! info "Documentation for DataJoint 2.0+" Python code examples use DataJoint 2.0 syntax...After:
!!! info "Documentation for DataJoint 2.0 (Pre-Release)" This documentation covers DataJoint 2.0, currently in pre-release. - Using stable 0.14.x? → Legacy docs - Want to test 2.0? → Installation guide - Migrating? → Migration guideUser Impact
Before (Confusion)
pip install datajoint, why doesn't the tutorial work?"After (Clarity)
Verification
No functional changes - pure documentation clarification:
Related