Add footnote hover?

Open
#85 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
markdown
Domain
documentation

Research direction

The footnote references are in the guide's Markdown pages, and the payload names no specific file. Start by finding the footnote references in the citation section at the top of the page and in the Zenodo JSON section, then remove the repeated references elsewhere. Pick one approach (dropping repeats or switching to tooltips) with the maintainers before editing. Done when each footnote is referenced only at the agreed spots and the bottom footnote section still renders.

Written by the indexing model from the issue text.

Description

Perfect, with two small tweaks!

One other thing I noticed while running it locally, though, is that it has a lot of these back arrows (😅 footnote challenge), which we could adjust through some special handling (remove the bolding altogether, though they'd still be there, use a custom script to only include the one from which the user clicked, or switch to footnote tooltips which show as a little hover pop-up). Such a change would be outside the scope of this PR; we do have a few other pages with footnotes referenced twice on a page.

Probably better is to just not include the footnote each time it's mentioned; limiting to the first mention in the citation section (at the top, the suggestion) and when it's mentioned in the Zenodo JSON section is probably sufficient.

Image

I tested the tooltip option and it doesn't change the footnote at the bottom of the page (might be nice to add them in--will open an issue).

Originally posted by @egrace479 in https://github.com/Imageomics/Collaborative-distributed-science-guide/pull/84#pullrequestreview-5342252207

Dominant language
Python
Stars
1
Forks
1
Avg merge
6d 1h
Merged PRs (30d)
1

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Imageomics/Collaborative-distributed-science-guide

All issues in Imageomics/Collaborative-distributed-science-guide

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.