Skip to content

Conversation

janfb
Copy link
Contributor

@janfb janfb commented Aug 23, 2024

  • move the two examples into the tutorials/ folder, adapt all links
  • go through all tutorials and reorder them with increasing numbers, group them by topic (a bit), fix all links
  • add implemented methods to landing page.

Problem: we sometimes link between tutorials, but it is not clear whether we should use the notebook links, or the markdown links of the converted notebooks. I now decided to use the markdown links, i.e., on the website the links smoothly refer to the corresponding tutorial on the website. However, when clicked in the notebook, e.g., when running the notebooks locally, the link will not work (because it links locally between the docs markdown files. As a help, I changed the link text to contain the tutorial number and name explicitly, so that it will be clear which tutorial we are linking to.

@janfb janfb requested a review from michaeldeistler August 23, 2024 07:51
@janfb janfb linked an issue Aug 23, 2024 that may be closed by this pull request
@janfb janfb added this to the Hackathon and release 0.23 milestone Aug 23, 2024
Copy link
Contributor

@michaeldeistler michaeldeistler left a comment

Choose a reason for hiding this comment

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

when running the notebooks locally, the link will not work I think that's fine

Copy link

codecov bot commented Aug 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.87%. Comparing base (b3254ed) to head (6fc91ca).
Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1231      +/-   ##
==========================================
- Coverage   85.44%   76.87%   -8.57%     
==========================================
  Files         101      101              
  Lines        7941     7945       +4     
==========================================
- Hits         6785     6108     -677     
- Misses       1156     1837     +681     
Flag Coverage Δ
unittests 76.87% <ø> (-8.57%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 25 files with indirect coverage changes

@janfb janfb merged commit 109d7e9 into main Aug 23, 2024
6 checks passed
@janfb janfb deleted the move-examples-to-tutorials branch August 23, 2024 09:07
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.

Move Examples into Tutorials
2 participants