JuliaGraphs / JuliaGraphs/Graphs.jl

Use DocumenterCitations in the docs

Open
#483 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
Julia
Stars
538
Forks
128
Avg merge
10h 25m
Merged PRs (30d)
2

Description

Plenty of places of the docs have or need citations to the original source of various algorithms. This would be made easier to handle if we start incorporating DocumenterCitations.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the documentation locations that contain or need citations and the DocumenterCitations documentation. Determine which citation workflow and source references should be incorporated; the work is done when the relevant algorithm citations are handled through DocumenterCitations.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.