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

Introduce folders in the tutorials sidebar and sort tutorials #368

Merged
merged 6 commits into from
Apr 5, 2024

Conversation

MakisH
Copy link
Member

@MakisH MakisH commented Apr 3, 2024

This is motivated by our sidebar not being scrollable, neither in Firefox, nor in Chromium.
Since we now have way too many tutorials, this is a bit chaotic.

This PR:

  • Introduces two folders: Basic cases and Further cases in the sidebar, similarly to our current categorization in the overview page.
  • Makes the "Introduction" a folder as well, which now includes two pages: "Overview" and "Visualization", which moves some useful information from the bottom of the previous "Introduction" page. The URL remains the same for the Introduction page (not for the visualization subsection, which should not have too many references yet). This now also looks better and clearer with two pages instead of one.
  • Adds a title above the sidebar.
  • The title includes a version: This is the version of the preCICE distribution. @uekerman: Should we change this to anything else?

Partially related to #345.

Screenshot from 2024-04-03 19-58-58

Screenshot from 2024-04-03 19-59-03

Screenshot from 2024-04-03 19-59-12

@MakisH MakisH added the technical Technical issues on the website label Apr 3, 2024
@MakisH MakisH requested review from uekerman and fsimonis April 3, 2024 18:07
@MakisH MakisH self-assigned this Apr 3, 2024
Copy link
Member

@uekerman uekerman left a comment

Choose a reason for hiding this comment

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

The folders are good. Also having visualization on a separate page.
I did not look at the rendered website.

_data/sidebars/tutorial_sidebar.yml Outdated Show resolved Hide resolved
@MakisH
Copy link
Member Author

MakisH commented Apr 4, 2024

@uekerman I forgot to upload the screenshots, you can now find them in the first post.

@uekerman
Copy link
Member

uekerman commented Apr 4, 2024

@uekerman I forgot to upload the screenshots, you can now find them in the first post.

Thanks! "Further cases" are prone to run into the same scrolling issue, no?

Would it be a good time to now also sort the cases alphabetically again?

@fsimonis
Copy link
Member

fsimonis commented Apr 5, 2024

Why "Basic" and "Further"?

Normally the antonym of "Basic" is "Advanced".

@MakisH
Copy link
Member Author

MakisH commented Apr 5, 2024

Why "Basic" and "Further"?

Normally the antonym of "Basic" is "Advanced".

  1. Because that's what we already are using in the overview and I did not want to open that box again now.
  2. Because what we mean is essentially "Look at this curated list first" and "If you are looking for something more specific, maybe you will find it here, but they are not necessarily as good". So, "further" is better than "advanced". And not all cases in the "further cases" are advanced.

@fsimonis
Copy link
Member

fsimonis commented Apr 5, 2024

👍 for consistency.

IMO this naming pair has been bad from the start and I agree with you that "Curated tutorials" is a better name for the section of curated tutorials 😉

@MakisH
Copy link
Member Author

MakisH commented Apr 5, 2024

Sorted alphabetically and removed the version:

Screenshot from 2024-04-05 22-14-26

@MakisH MakisH changed the title Introduce folders in the tutorials sidebar Introduce folders in the tutorials sidebar and sort tutorials Apr 5, 2024
@MakisH MakisH merged commit 5cfedb0 into precice:master Apr 5, 2024
2 checks passed
@MakisH MakisH deleted the tutorials-sidebar branch April 5, 2024 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
technical Technical issues on the website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants