Transfer material from datajoint/datajoint-elements repository#7
Merged
Conversation
Co-authored-by: Chris Brozdowski <CBrozdowski@yahoo.com>
Co-authored-by: Chris Brozdowski <CBrozdowski@yahoo.com>
Collaborator
Author
|
Thanks for the feedback @CBroz1! I have incorporated your suggestions. |
CBroz1
previously approved these changes
Oct 11, 2022
Collaborator
Author
|
As an aside, not sure why the |
Contributor
There was a commit during my first review, but I didn't refresh the page. Maybe it could've rendered my first review 'stale' automatically? I'm not familiar with the stale review nomenclature |
Contributor
CBroz1
previously approved these changes
Oct 12, 2022
CBroz1
reviewed
Oct 12, 2022
CBroz1
previously approved these changes
Oct 13, 2022
Co-authored-by: Kabilar Gunalan <kabilar@datajoint.com>
Add youtube links. DesignPrinciples -> Concepts
Collaborator
Author
|
Renamed |
guzman-raphael
approved these changes
Oct 21, 2022
dimitri-yatsenko
added a commit
that referenced
this pull request
Jan 14, 2026
Addresses gap identified in cohesion review (COHESION-REVIEW.md Issue #7): - Users don't understand spec dependencies - No guidance on reading order - Missing links to related how-to/explanation pages Enhancements: 1. How to Use These Specifications section: - Clear guidance for new users (start with tutorials) - For implementers (use specs as authoritative sources) - For debugging (clarify ambiguous behavior) 2. Reading Order section: - Foundation (3 specs - start here) - Branching paths: Query Algebra, Data Operations, Object Storage - Prerequisites listed for each path - Advanced topics (master-part, virtual schemas) 3. Enhanced specification tables: - Added Prerequisites column (shows dependencies) - Added Related How-To column (links to practical guides) - Added Related Explanation column (links to conceptual docs) - Key concepts summary for each topic 4. Clear progression paths: - Foundation → choose based on needs - Prerequisites prevent getting lost - Related docs provide context and practical application Cross-references added: - 15+ how-to guide links - 10+ explanation links - All prerequisites documented Impact: - Users understand which specs to read first - Clear path from basics to advanced - Easy navigation to related practical/conceptual docs - Prevents reading specs in wrong order Fixes: COHESION-REVIEW.md Issue #7 (Medium Priority)
This was referenced Jan 14, 2026
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
3 participants
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.
datajoint/datajoint-elementsrepository.