pytopia / CS-Tutorial

Source Code for CS Courses Offered by Ali Hejazizo
https://www.hejazizo.com
MIT License
184 stars 107 forks source link

add "back to top" links #4

Open sfarajnia opened 2 years ago

sfarajnia commented 2 years ago

Tables of contents are well written and structured the notebooks in a nice manner. However, the content of the notebook would be more user-friendly if there would be "back to top" link beside the titles inside the notebook. I've added "back-to-top" links to python notebook (Basics, Object Oriented Programming and Modular Programming)

review-notebook-app[bot] commented 2 years ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

MahtabRanjbar commented 2 years ago

Writing "Back to top" for each subtopic does not seem very nice. I think it is better to use the relevant icon instead of writing "back to top".

sfarajnia commented 2 years ago

Writing "Back to top" for each subtopic does not seem very nice. I think it is better to use the relevant icon instead of writing "back to top".

Good idea! I will replace text with an icon.

sfarajnia commented 2 years ago

Writing "Back to top" for each subtopic does not seem very nice. I think it is better to use the relevant icon instead of writing "back to top".

hi, again. @MahtabRanjbar
I've updated all notebooks and added ICONS for "back to top" links. This is a screenshot from one of the titles of the advanced folder. The "blue top_arrow", if clicked, goes to the table of contents:
image

MahtabRanjbar commented 2 years ago

@sfarajnia good job. I think you also feel it has a nicer and cleaner structure now.

hejazizo commented 2 years ago

After putting some thought into this, I think we should not do this manually.

You can simply write a code to add the link to a jupyter notebook file cause it's basically a json file. You should add a cell at the end of it that contains a back to top link.

arf1372 commented 2 years ago

After putting some thought into this, I think we should not do this manually.

I don't get what your point is. Having a "back to top" link besides each heading would be nice-to-have (actually, I don't use them but someone may find it useful).

You can simply write a code to add the link to a jupyter notebook file cause it's basically a json file. You should add a cell at the end of it that contains a back to top link.

Also, I don't understand what you mean by mentioning ipynb files are just jsons.

CLAassistant commented 1 year ago

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 4 committers have signed the CLA.

:white_check_mark: hejazizo
:x: Ali
:x: MahtabRanjbar
:x: sfarajnia


Ali seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.