JuliaPluto/Pluto.jl

Live Docs: show package defining a function

Open

#2.737 geöffnet am 6. Dez. 2023

Auf GitHub ansehen
 (6 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Julia (5.295 Stars) (329 Forks)batch import
Live Docsbackendenhancementfrontendgood first issue

Beschreibung

When reading docs, it would be nice to show from which package a function/method originates.

Current:

Contributor Guide

Tech Stack
Keine
Domain
documentationfrontend
Issue Type
feature
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-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Understanding of Pluto's live docs structureBasic HTML/CSS knowledge
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
Review the Pluto.jl source code to understand how live docs are rendered. Search for the function display code (likely in a Julia file or a .js file). Look at the issue comments for any hints on desired implementation. Modify the relevant template or component to include the package name. Test the changes locally.