GitHub link in docs points to ChainRulesCore.jl
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- julia
- Domain
- documentation
Research direction
Start by locating the documentation configuration that controls the GitHub icon link, noting that the docs are hosted by ChainRulesCore.jl. Update the link so it targets the ChainRules.jl source repository, then verify that the icon resolves to the expected GitHub URL.
Written by the indexing model from the issue text.
Description
I'm checking out this package's awesome documentation for inspiration for my own work and noticed a tiny, but potentially confusing issue for certain new users (like myself).
If I'm in the docs[^1], and click the "GitHub" icon at the top right of the page, I'm directed to the ChainRulesCore.jl instead of the ChainRules.jl source code.
Since the docs is about the ChainRules.jl package, I would expect the link to point to the ChainRules.jl source code.
[^1]: I now realize the docs is hosted by ChainRulesCore.jl. This is likely why the link points where it does.
- Dominant language
- Julia
- Stars
- 479
- Forks
- 100
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 14
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from JuliaDiff/ChainRules.jl
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
JuliaDiff/ChainRules.jl#871 · 1 comment ·
Maintainers usually reply within 1 day
-
`sum` rules do not match the signatures of the Base methodsMay be free again A pull request for this issue was closed without being merged. Open
Difficulty 4/5 3-5 days Newbie friendliness 35/100
JuliaDiff/ChainRules.jl#868 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
JuliaDiff/ChainRules.jl#863 ·
Maintainers usually reply within 1 day
-
refactoring
Difficulty 4/5 3-5 days Newbie friendliness 35/100
JuliaDiff/ChainRules.jl#815 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 45/100
JuliaDiff/ChainRules.jl#810 ·
Maintainers usually reply within 1 day
All issues in JuliaDiff/ChainRules.jl
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 62/100
JuliaStats/LogExpFunctions.jl#134 · 2 comments ·
-
code bug PowerSystems 6.0
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Sienna-Platform/PowerSystems.jl#1849 ·
Maintainers usually reply within 7 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 86/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
FluxML/Metalhead.jl#407 ·
Maintainers usually reply within 1 day