JuliaDynamics / JuliaDynamics/RecurrenceAnalysis.jl
Use DocumenterCitations.jl to re-factor how we cite literature in the documentation
Open
Nobody has claimed this yet.
documentation
good first issue
- Dominant language
- Julia
- Stars
- 50
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the DocumenterCitations.jl documentation and comparing its setup with the Attractors.jl example. Update RecurrenceAnalysis.jl's documentation so literature citations use DocumenterCitations.jl and BiBTeX consistently; done means the documentation builds with the new citation setup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100