Skip to content

docs: point to the Zenodo archive from the README, the citation file and the website - #29

Merged
Paururo merged 1 commit into
mainfrom
docs/zenodo-doi
Oct 18, 2026
Merged

Paururo merged 1 commit into
mainfrom
docs/zenodo-doi

Conversation

@Paururo

@Paururo Paururo commented Oct 18, 2026

Copy link
Copy Markdown
Member

Recore 1.0.0 is on Zenodo: doi:10.5281/zenodo.23448591 for this version, and the concept DOI doi:10.5281/zenodo.23448590, which always resolves to the latest one. Zenodo took the title, both authors with their ORCIDs and affiliation, and the AGPL-3.0-only licence from CITATION.cff.

What changes

  • README: a DOI badge in the header (concept DOI), and under the paper citation a line with both DOIs.
  • CITATION.cff: doi (concept) and an identifiers list with both DOIs described.
  • Citation page: which DOI to cite, and a @software BibTeX entry for 1.0.0.
  • Website footer: a "Software" line linking the archive, on every page.
  • tools/check_site.py fails if the DOI in CITATION.cff is missing from the README, the citation page or the footer (broken on purpose and caught).

Locally fmt, clippy, the tests, the build, check_site.py --run-tutorial and the auto-merge gate check all pass.

…and the website

Recore 1.0.0 is archived on Zenodo, so the README carries the DOI badge and both DOIs, CITATION.cff holds them, the citation page has a BibTeX entry for the software and the footer links the archive. check_site.py fails if the DOI in CITATION.cff goes missing from any of those places.
@Paururo Paururo added documentation Improvements or additions to documentation ci Workflows, automation config, and the tools/ scripts labels Oct 18, 2026
@Paururo
Paururo merged commit c468438 into main Oct 18, 2026
11 checks passed
@Paururo
Paururo deleted the docs/zenodo-doi branch October 18, 2026 08:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Workflows, automation config, and the tools/ scripts documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant