Add footnote hover?

オープン
#85 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
48/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
markdown
領域
documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
Python
スター
1
フォーク
1
平均マージ
6日 1時間
マージ済み PR(30日)
1

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Imageomics/Collaborative-distributed-science-guide のほかの issue

Imageomics/Collaborative-distributed-science-guide の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。