Repository navigation
docs: add the Zenodo DOI to README and CFF - #47
Merged
Merged
Conversation
Add the DOI badge and the concept DOI to the Citation section and CITATION.cff, as in foca and cloud-registry. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis documentation-only change adds the Zenodo concept DOI 10.5281/zenodo.23858996 to the README, generated documentation citation content, and CITATION.cff, including identifiers for version-aware citation. File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
uniqueg
marked this pull request as ready for review
November 1, 2026 13:51
There was a problem hiding this comment.
Hey - I've reviewed your changes and they look great!
Linked issues
#46 docs: add the Zenodo DOI to README and citation · 3 of 3 met
| # | Requirement | Status | Notes |
|---|---|---|---|
| 1 | Add the DOI badge to the README. | ✅ Met | The README displays a DOI badge linked to the concept DOI. |
| 2 | Point the Citation section, also shown on the docs home page, to the concept DOI. | ✅ Met | The README Citation section links to 10.5281/zenodo.23858996; docs/index.md includes that section. |
| 3 | Add the concept DOI to CITATION.cff in doi and identifiers. | ✅ Met | CITATION.cff sets doi and the DOI identifier value to 10.5281/zenodo.23858996. |
Sourcery assessment
Approved.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the Zenodo concept DOI 10.5281/zenodo.23858996 (always resolves to the latest version; one concept covers the whole repository) to the README badges, the Citation section (also shown on the docs home page via snippet) and
CITATION.cff(doiandidentifiers), matching foca and cloud-registry. Per-package READMEs have no Citation section and stay unchanged.Closes #46
Verification
cffconvert==2.0.0 --validate -i CITATION.cff: validmkdocs build --strict: passespython -m scripts.checks check: passesLight lane: docs and metadata only, no logic.
Declined review findings
None (light lane, no reviewer subagents).
Open questions
None.
🤖 Generated with Claude Code
Summary by Sourcery
Publish the project’s Zenodo DOI across its documentation and citation metadata.
Enhancements:
Documentation: