JuliaDynamics/RecurrenceAnalysis.jl

Use DocumenterCitations.jl to re-factor how we cite literature in the documentation

Open

#162 opened on Jun 9, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Julia (16 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (50 stars)
PR merge metrics
 (PR metrics pending)

Description

In other projects in JuliaDynamics we moved to DocumenterCitations.jl to cite literature using BiBTeX. It is extremely simple to use, and its documentation is very good. See Attractors.jl for an example of using it in a real project.

Contributor guide

Research direction
Learn how DocumenterCitations.jl works by reviewing its documentation and the example in Attractors.jl, then adapt the citation system in RecurrenceAnalysis.jl accordingly.
Tech stack
julia
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Julia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75