patrick-kidger / patrick-kidger/diffrax
Add links to references
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 2.1k
- Forks
- 189
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 1
Description
We have a lot of BibTeX references specified throughout the documentation. It would be nice to add:
- DOI references to the BibTeX itself
@article{blahblah,
...
doi={...}
}
- arXiv/DOI hyperlinks adjacent to the BibTeX
[arXiv](...)
@article{...
}
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
Search the documentation for the BibTeX references mentioned in the issue and inspect how each entry is currently presented. Add DOI fields where available and adjacent arXiv or DOI links, then verify that the affected documentation renders correctly and every changed reference remains valid.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100