search

pyOpenSci / python-package-guide

scientific Python package recommendations & guidance curated by pyOpenSci
https://www.pyopensci.org/python-package-guide/
Other
89 stars 51 forks source link

Create footnotes to external references #155

Open lwasser opened 7 months ago

lwasser commented 7 months ago

In our guidebook review @Midnighter noted that we have a lot of external links to content that will take people away from our guidebook. in many cases it is external information. the comment discussion is below:

https://github.com/pyOpenSci/python-package-guide/pull/144#issuecomment-1881791596

i think this is a really good point. we might want to use footnotes which are a part of the theme we are using instead. i'm creating this issue so we can move forward with merging the existing pr while thinking about overall style!

lwasser commented 7 months ago

looking at this in the text, i think footnotes are a great way to keep user focus on the lesson content while also providing additional resources. We will want to go back through the guide and be consistent with using them. But for now we can use them on new lesson pages!

willingc commented 7 months ago

Next action for contributors: