JuliaDiff / JuliaDiff/ChainRules.jl
GitHub link in docs points to ChainRulesCore.jl
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 475
- Forks
- 98
- PR merge metrics
- No merged PRs in 30d
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.
Contributor guide
No contributing guide indexed for this repository
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 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.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100