Skip to content

docs: add Zenodo DOI badge and CITATION identifiers - #17

Merged
musharna merged 2 commits into
mainfrom
chore/doi-badges
Jul 28, 2026
Merged

docs: add Zenodo DOI badge and CITATION identifiers#17
musharna merged 2 commits into
mainfrom
chore/doi-badges

Conversation

@musharna

@musharna musharna commented Jul 28, 2026

Copy link
Copy Markdown
Owner

The DOIs are live

Zenodo archived the v0.5.1 release and minted:

DOI
Concept (always resolves to the newest release) 10.5281/zenodo.21636354
This release (v0.5.1) 10.5281/zenodo.21636355

Zenodo picked up the title, description, keywords, licence and ORCID from the
.zenodo.json added earlier, so the record reads correctly rather than being inferred
from the repository.

What this PR adds

  • README — a DOI badge, pointing at the concept DOI so it keeps resolving to the
    latest release instead of pinning to v0.5.1 forever.
  • CITATION.cff — a top-level doi: plus an identifiers: block carrying both
    the concept DOI and this release's DOI. GitHub's Cite this repository panel and the
    APA/BibTeX exports now include the DOI.

Verified

Re-validated against the CFF 1.2.0 schema with cffconvert after the edit:

Citation metadata are valid according to schema version 1.2.0.

A deliberately corrupted type: was confirmed to fail the same check, so the validation
is real rather than vacuous.

🤖 Generated with Claude Code

@musharna
musharna marked this pull request as ready for review July 28, 2026 04:20
@musharna
musharna merged commit 963ae10 into main Jul 28, 2026
11 checks passed
@musharna
musharna deleted the chore/doi-badges branch July 28, 2026 04:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant