Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tutorials page alternative #3230

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open

Tutorials page alternative #3230

wants to merge 20 commits into from

Conversation

lordy5
Copy link
Collaborator

@lordy5 lordy5 commented Mar 3, 2025

In this PR I created an alternative option for the tutorials index page. I think it is better than the previous option and has the following differences:

  1. Broke up longer tutorial groups, like scRNA-seq into smaller subgroups, each with its own dropdown.
  2. Used MyST cards instead of a list-table for each tutorial link. I think this looks less cluttered.
  3. Used markdown headers so that users can easily navigate to the model type they want using the right sidebar.
  4. Reordered tutorials and subgroups in a more logical way so that the page reads more like a tutorial.
  5. Added descriptions for each subgroup so users have a better idea of whether those tutorials are relevant to them.

I think something like this layout is about as simplified as I can get with built in MyST while still allowing the user to skip to particular sections using the right sidebar. From the different options I've already tried, I think if there is an additional layer of subgroupings/labels/dropdowns then the page becomes too cluttered and is less helpful.

Still open for suggested changes and improvements of course.

Screenshot 2025-03-03 at 8 07 07 PM

@lordy5 lordy5 added tutorials on-merge: backport to 1.3.x on-merge: backport to 1.3.x labels Mar 3, 2025
Copy link

codecov bot commented Mar 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.69%. Comparing base (8e95508) to head (0828988).

❗ There is a different number of reports uploaded between BASE (8e95508) and HEAD (0828988). Click for more details.

HEAD has 8 uploads less than BASE
Flag BASE (8e95508) HEAD (0828988)
11 3
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3230      +/-   ##
==========================================
- Coverage   86.85%   80.69%   -6.16%     
==========================================
  Files         193      193              
  Lines       17080    17080              
==========================================
- Hits        14835    13783    -1052     
- Misses       2245     3297    +1052     

see 27 files with indirect coverage changes

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@lordy5 lordy5 marked this pull request as ready for review March 4, 2025 04:27
@lordy5 lordy5 requested review from canergen and ori-kron-wis March 4, 2025 04:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
on-merge: backport to 1.3.x on-merge: backport to 1.3.x tutorials
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant