python-package-guide icon indicating copy to clipboard operation
python-package-guide copied to clipboard

Create footnotes to external references

Open lwasser opened this issue 1 year ago • 2 comments

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 avatar Jan 08 '24 20:01 lwasser

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!

lwasser avatar Jan 08 '24 20:01 lwasser

Next action for contributors:

  • Go through existing guide content and add footnotes

willingc avatar Jan 11 '24 02:01 willingc