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

Add dropdowns to all chapter for key takeaways and environment setup #333

Merged
merged 20 commits into from
Feb 20, 2025

Conversation

LuisHeinzlmeier
Copy link
Collaborator

@LuisHeinzlmeier LuisHeinzlmeier commented Feb 14, 2025

I added two types of dropdown boxes to all the chapters:

1. Key takeaways:

  • Each bullet point gets its card, which links to the corresponding paragraph when clicking.
  • 1-5 bullet points for each chapter.

2. Environment setup:

  • Explains how to set up an environment with the corresponding yml file.
  • Loads default_text_env_setup.md for the "steps"-tab and the corresponding yml file for the "yml"-tab.
  • I excluded this box from a chapter if the text had no code (e.g., introduction chapters).

Please have a look when you have time :)

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link

github-actions bot commented Feb 14, 2025

PR Preview Action v1.6.0

🧬 View preview of single-cell best practices at
https://theislab.github.io/single-cell-best-practices/pr-preview/pr-333/

Built to branch gh-pages at 2025-02-20 12:55 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

Copy link
Member

@Zethson Zethson left a comment

Choose a reason for hiding this comment

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

This is awesome!

A few requests:

  1. Could we spin your observations concerning missing and too general environments into a follow up issue, please?
  2. I wonder whether we should have the boxes after the chapter title. What do you think?

@@ -0,0 +1,28 @@
1. **Save the yml content**:
Copy link
Member

Choose a reason for hiding this comment

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

There might need to be another step before that which explains how to install Conda. Could you add one sentence on that, please?

@LuisHeinzlmeier
Copy link
Collaborator Author

This is awesome!

A few requests:

  1. Could we spin your observations concerning missing and too general environments into a follow up issue, please?
  2. I wonder whether we should have the boxes after the chapter title. What do you think?
  1. done! Missing yml files for every chapter/notebook #336
  2. Yeah, I think I am generally not super happy with the box yet. I think the location is good at the beginning, but the box is very dominant!
    What do you think about this design with a small badge/button on top referencing the box at the bottom?
    Here, I added the box after the title to see what I would look like.

@Zethson
Copy link
Member

Zethson commented Feb 17, 2025

Yeah, I think I am generally not super happy with the box yet. I think the location is good at the beginning, but the box is very dominant!
What do you think about this design with a small badge/button on top referencing the box at the bottom?
Here, I added the box after the title to see what I would look like.

Both options are great! But in both cases, I would keep it as a dropdown. It just makes the chapters appear less long. It is however a bit weird to me that the environment setup is at the bottom for the scrollable option. I know that we have the session-info at the bottom but that seems to be more common than a "how to setup the environment guide".

Should we ask more people for feedback? We can ask in the big sc-best-practices channel. We can also make a decision among the three of us.

@LuisHeinzlmeier LuisHeinzlmeier changed the title Info box for environment setup Add boxes to all chapter for key takeaways and environment setup Feb 20, 2025
@LuisHeinzlmeier LuisHeinzlmeier changed the title Add boxes to all chapter for key takeaways and environment setup Add dropdown to all chapter for 'key takeaways' and 'environment setup' Feb 20, 2025
@LuisHeinzlmeier LuisHeinzlmeier changed the title Add dropdown to all chapter for 'key takeaways' and 'environment setup' Add dropdown to all chapter for key takeaways and 'environment setup' Feb 20, 2025
@LuisHeinzlmeier LuisHeinzlmeier changed the title Add dropdown to all chapter for key takeaways and 'environment setup' Add dropdown to all chapter for key takeaways and environment setup Feb 20, 2025
@LuisHeinzlmeier LuisHeinzlmeier changed the title Add dropdown to all chapter for key takeaways and environment setup Add dropdowns to all chapter for key takeaways and environment setup Feb 20, 2025
@LuisHeinzlmeier
Copy link
Collaborator Author

Finally! 🎊

Copy link
Member

@Zethson Zethson left a comment

Choose a reason for hiding this comment

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

Great!

@Zethson Zethson merged commit 41b1cb5 into main Feb 20, 2025
38 checks passed
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.

Add info box to every notebook that points to the associated conda environment file
2 participants