Skip to content

Add cards to core#6

Merged
dimitri-yatsenko merged 3 commits into
datajoint:mainfrom
guzman-raphael:cards
Oct 7, 2022
Merged

Add cards to core#6
dimitri-yatsenko merged 3 commits into
datajoint:mainfrom
guzman-raphael:cards

Conversation

@guzman-raphael
Copy link
Copy Markdown
Contributor

In this PR, we:

  • Add cards to core
  • Utilize mkdocs-material-insiders (if available)
  • Enable fontawesome
  • Fix color bug in mobile navigation

Here is a preview of how the cards look rendered:

image

@kabilar kabilar self-assigned this Oct 7, 2022
Copy link
Copy Markdown
Collaborator

@kabilar kabilar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @guzman-raphael. Great work! I have added a few minor comments.

Comment thread .docker/Dockerfile
Comment thread src/core.md
@dimitri-yatsenko dimitri-yatsenko merged commit cc52529 into datajoint:main Oct 7, 2022
dimitri-yatsenko added a commit that referenced this pull request Jan 14, 2026
Addresses gap identified in cohesion review (COHESION-REVIEW.md Issue #6):
- Users confused choosing between blob types
- Decision criteria scattered across multiple docs
- No single authoritative guide for codec selection

New guide (choose-storage-type.md) provides:
- Quick decision tree (4-level flowchart)
- Size guidelines (< 1 MB, 1-100 MB, > 100 MB)
- Access pattern guidelines (full vs streaming vs lazy)
- Lifecycle management comparison (DataJoint-managed vs user-managed)
- Detailed codec comparison tables
- 3 realistic scenario examples (image processing, ephys, calcium imaging)
- Configuration examples (single store vs multiple stores)
- Performance considerations (read, write, storage efficiency)
- Migration patterns (in-table → object store, hash → schema)
- Troubleshooting common issues

Coverage:
- <blob> (in-table)
- <blob@> (hash-addressed)
- <npy@> (NumPy arrays)
- <object@> (Zarr/HDF5/streaming)
- <filepath@> (user-managed references)

Also:
- Added to how-to/index.md under Object Storage (first item - decision guide)
- Regenerated llms-full.txt

Impact:
- Users have single authoritative codec decision guide
- Clear decision criteria for every codec type
- Realistic examples from scientific workflows
- Reduces trial-and-error in codec selection

Fixes: COHESION-REVIEW.md Issue #6 (Medium Priority)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants