Skip to content

Categorise recipes + rename recipes and tutorials to dishes and cooking lessons #529

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

Merged
merged 24 commits into from
Jun 16, 2025

Conversation

navidcy
Copy link
Collaborator

@navidcy navidcy commented Jun 15, 2025

@angus-g I tried to add subcategories to recipes in anticipation of #523 and moving towards #182.
But I failed... I did a few other attempts locally that also failed. Do you know how to achieve this?

I'm thinking that Recipes should have subcategories eg

Recipes
├─ Appetisers (easy)
├─ Mains (medium-to-hard)
└─ Local Dishes (regional setups)

Or if you figure how to set up the categorisation it'd be easy to tweak laters.

cc @julia-neme

@angus-g angus-g force-pushed the ncc/subcategories branch from 1e55c5d to 5875aef Compare June 16, 2025 00:52
@angus-g
Copy link
Contributor

angus-g commented Jun 16, 2025

Sorry, a bit of fiddling around but this should give you an idea of how to do it.

@navidcy
Copy link
Collaborator Author

navidcy commented Jun 16, 2025

T H A N K S!

@navidcy navidcy linked an issue Jun 16, 2025 that may be closed by this pull request
@navidcy
Copy link
Collaborator Author

navidcy commented Jun 16, 2025

@julia-neme, @adele-morrison, @edoddridge: could someone have a look/review?

A preview of the docs is found at https://cosima-recipes--529.org.readthedocs.build/en/529/

@navidcy navidcy requested a review from edoddridge June 16, 2025 03:52
@navidcy
Copy link
Collaborator Author

navidcy commented Jun 16, 2025

I quickly did a split between mains and appetisers but I'm not strong about it! We can also change later.

@edoddridge
Copy link
Collaborator

My biggest concern with this is that the tutorials don't fit the menu analogy. I guess I would have expected them to be in the appetisers?

@navidcy
Copy link
Collaborator Author

navidcy commented Jun 16, 2025

How about:

  • Appetisers (Tutorials; the place everybody should start)
  • Small Dishes (Easy recipes)
  • Mains (Advanced/Elaborate recipes)
  • Local Cuisine (Regional configurations)

@chrisb13
Copy link
Contributor

These categories are yummy! Thanks @navidcy and @angus-g.

This is off topic but could the docs be more visible somehow? Shamefully, today is the first time I've looked at it. I've always just read the README and then looked at tutorials etc. One option I guess is to move all the README content into the docs and only have a link to the docs on the README (reduces admin burden too). Just a thought.

@navidcy
Copy link
Collaborator Author

navidcy commented Jun 16, 2025

These categories are yummy! Thanks @navidcy and @angus-g.

This is off topic but could the docs be more visible somehow? Shamefully, today is the first time I've looked at it. I've always just read the README and then looked at tutorials etc. One option I guess is to move all the README content into the docs and only have a link to the docs on the README (reduces admin burden too). Just a thought.

But the README does link to the docs! All these are links to the docs:

Screenshot 2025-06-16 at 4 04 02 pm

navidcy and others added 2 commits June 16, 2025 16:08
Co-authored-by: Angus Gibson <angus@agibson.me>
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@navidcy
Copy link
Collaborator Author

navidcy commented Jun 16, 2025

How about:

  • Appetisers (Tutorials; the place everybody should start)
  • Small Dishes (Easy recipes)
  • Mains (Advanced/Elaborate recipes)
  • Local Cuisine (Regional configurations)

If we are doing that we don't need subcategories, right? At the moment the "dishes" are under "Recipes" as a subcategory:

  • Tutorials
  • Recipes
    • Appetizers
    • Mains
    • Local

@chrisb13
Copy link
Contributor

But the README does link to the docs! All these are links to the docs:

Yikes, mea culpa -- I totally missed that!

@navidcy
Copy link
Collaborator Author

navidcy commented Jun 16, 2025

But the README does link to the docs! All these are links to the docs:

Yikes, mea culpa -- I totally missed that!

A lot of people miss the docs or seem to have a tendency to avoid them and I don't know why!

@navidcy
Copy link
Collaborator Author

navidcy commented Jun 16, 2025

@edoddridge I renamed the Tutorials to "Cooking Lessons 101"; how's that?

@navidcy navidcy changed the title Categorise recipes Categorise recipes + rename recipes and tutorials to dishes and cooking lessons Jun 16, 2025
@navidcy
Copy link
Collaborator Author

navidcy commented Jun 16, 2025

I think this PR is ready for review!

@edoddridge
Copy link
Collaborator

@edoddridge I renamed the Tutorials to "Cooking Lessons 101"; how's that?

Looks good to me. It fits the theme nicely.

Copy link
Collaborator

@edoddridge edoddridge left a comment

Choose a reason for hiding this comment

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

LGTM


.. nbgallery::
:caption: Tutorials
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is a nice catch - harmonising and simplifying the look. 👍

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

:)

@navidcy
Copy link
Collaborator Author

navidcy commented Jun 16, 2025

I'll merge. If there is disagreements regarding a dish being a main while being put in the appetisers we can adjust later!

@navidcy navidcy merged commit 6fdbdba into main Jun 16, 2025
3 checks passed
@navidcy navidcy deleted the ncc/subcategories branch June 16, 2025 23:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Further categorisation of Recipes
4 participants