Add learning paths to tutorials for better navigation#113
Closed
dimitri-yatsenko wants to merge 3 commits into
Closed
Add learning paths to tutorials for better navigation#113dimitri-yatsenko wants to merge 3 commits into
dimitri-yatsenko wants to merge 3 commits into
Conversation
- 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
Addresses gap identified in cohesion review (COHESION-REVIEW.md Issue #5): - User journey unclear (tutorials → how-to → reference progression not explicit) - No recommended reading order by skill level - Users don't know which tutorial sequence matches their goals New Learning Paths section provides: - 4 clear skill-based paths with distinct goals - Time estimates for beginner path - Prerequisites for each path - Explicit next steps after completing each path Paths: 1. 🌱 New to DataJoint (beginner: 5 tutorials + 1 example → ~3 hours) 2. 🚀 Building Production Pipelines (intermediate: computation + distributed) 3. 🧪 Domain-Specific Applications (neuroscience + general patterns) 4. 🔧 Extending DataJoint (advanced: custom codecs + type system) Each path includes: - Clear goal statement - Prerequisites (where applicable) - Numbered tutorial sequence with time estimates (for beginners) - Links to follow-up how-to guides and explanations - External resources where relevant (DataJoint Elements) Also regenerated llms-full.txt Impact: - New users have clear entry point and progression - Intermediate users find production pipeline path - Advanced users navigate to extension capabilities - Reduces confusion about "what to read next" Fixes: COHESION-REVIEW.md Issue #5 (Medium Priority)
This was referenced Jan 14, 2026
Member
Author
|
Consolidated into #119 - Documentation Cohesion Review: Comprehensive Improvements for DataJoint 2.0 |
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
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
Adds clear skill-based learning paths to the tutorials index, addressing navigation confusion identified in the cohesion review.
Problem
From cohesion review (COHESION-REVIEW.md Issue #5, Medium Priority):
Solution
New "Learning Paths" section with 4 clear skill-based progressions:
🌱 New to DataJoint (Beginner)
🚀 Building Production Pipelines (Intermediate)
🧪 Domain-Specific Applications
🔧 Extending DataJoint (Advanced)
Design Decisions
Emoji indicators:
Structure per path:
Placement:
User Impact
Before (Confusion)
After (Clarity)
Visual Structure
Cross-References
Each path links to:
Related