forrtproject/forrtproject.github.io

Improve reference display

Open

#200 geöffnet am 18. Nov. 2024

Auf GitHub ansehen
 (16 Kommentare) (1 Reaktion) (1 zugewiesene Person)HTML (33 Forks)auto 404
content relatedenhancementgood first issueneeds-discussionstale

Repository-Metriken

Stars
 (43 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

The website is full of citations that are currently not systematically linked to references - so that they are of little use. We have a standing promise to change that in the glossary (#135) but the issue also arises in many other places.

Could we fix this across the webpage? I can think of three options:

  • project-specific reference pages, with links from the specific mentions
  • FORRT wide reference page, with links from the specific mentions

Or, my favorite:

  • when clicking on the citation, a popup appears with full reference and abstract - linking to the original source. Very simple dummy (with ChatGPT generated code) below, should of course be prettier.

image popup_test.html.zip

@flavioazevedo would this solution make sense for you?

Contributor Guide

Research-Richtung
Untersuche das vorhandene Zitierungs Markup und implementiere eine Popup Lösung mit HTML/CSS/JavaScript.
Tech Stack
htmljavascript
Domain
frontend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitHTMLCSSJavaScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70