Conversation
maxinelasp
requested review from
medley56 and
mmaclay
and removed request for
Copilot and
mmaclay
There was a problem hiding this comment.
Pull request overview
This PR refreshes Curryer documentation by adding DOI badges and citations, reorganizing content between README.md and the documentation site, and introducing a new acknowledgement page. The changes aim to improve citation tracking and make documentation more accessible.
Changes:
- Added DOI badge and Zenodo citation across documentation files
- Moved detailed installation, examples, and SPICE path handling documentation from README.md to docs/source/users.md
- Created new acknowledgement.md page for citation guidelines
- Updated CITATION.cff with DOI identifier and quote consistency
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| README.md | Streamlined to focus on overview with links to detailed docs; added badges; moved examples to users.md |
| docs/source/users.md | Added comprehensive content from README including installation details, examples, and SPICE path handling |
| docs/source/acknowledgement.md | New file providing citation information and DOI for academic use |
| CITATION.cff | Added DOI identifier and standardized quote formatting |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. ❌ Your project status has failed because the head coverage (81.30%) is below the target coverage (95.00%). You can increase the head coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## main #120 +/- ##
=======================================
Coverage 73.62% 73.62%
=======================================
Files 67 67
Lines 10655 10655
Branches 1204 1204
=======================================
Hits 7845 7845
Misses 2343 2343
Partials 467 467 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
mmaclay
left a comment
mmaclay
left a comment
There was a problem hiding this comment.
This is awesome, Maxine. Such a big impact on external visibility and citations.
I only added a couple of very minor comments:
linking a page to itself (which was already in the main branch and not a problem), and noting the Zenodo DOI having two versions (which appear to be linked).
good to go on my end.
Thanks for doing this!
Including adding a DOI.
This moves and rearranges some Curryer documentation. I also have a PR open for the dev guide and will update links in Curryer docs once that is merged.