JuliaPluto/Pluto.jl

Live Docs: show package defining a function

Open

#2,737 opened on Dec 6, 2023

View on GitHub
 (7 comments) (1 reaction) (0 assignees)Julia (329 forks)batch import
Live Docsbackendenhancementfrontendgood first issue

Repository metrics

Stars
 (5,295 stars)
PR merge metrics
 (Avg merge 3d 17h) (16 merged PRs in 30d)

Description

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

Current:

Contributor guide

Research direction
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.
Tech stack
None
Domain
documentationfrontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Understanding of Pluto's live docs structureBasic HTML/CSS knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70