Skip to content

docs: add the Zenodo DOI to README and CFF - #47

Merged
uniqueg merged 1 commit into
devfrom
docs/46-zenodo-doi
Nov 1, 2026
Merged

uniqueg merged 1 commit into
devfrom
docs/46-zenodo-doi

Conversation

@uniqueg

@uniqueg uniqueg commented Nov 1, 2026 •

Copy link
Copy Markdown
Member

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 (doi and identifiers), 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: valid
  • mkdocs build --strict: passes
  • python -m scripts.checks check: passes
  • pre-commit: all hooks pass except mypy, which fails only because the hook's environment lacks mypy in this clone (CI runs it)

Light 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:

  • Add the Zenodo concept DOI to the project README and citation metadata so users can identify and cite the repository and its latest release.

Documentation:

  • Add a DOI badge and updated citation guidance to the README, including links to the latest Zenodo record and version-specific DOIs.

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>
@sourcery-ai

sourcery-ai Bot commented Nov 1, 2026 •

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This 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

Change Details Files
Add repository-wide Zenodo concept DOI metadata and citation guidance.
  • Add a clickable DOI badge linking to the Zenodo concept record.
  • Update the Citation section with latest-version and version-specific DOI guidance.
  • Expose the DOI and version identifiers in standardized citation metadata.
  • Reuse the updated citation content on the documentation home page via the existing snippet mechanism.
README.md
CITATION.cff

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@uniqueg
uniqueg marked this pull request as ready for review November 1, 2026 13:51

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@uniqueg
uniqueg merged commit 7714e1d into dev Nov 1, 2026
25 checks passed
@uniqueg
uniqueg deleted the docs/46-zenodo-doi branch November 1, 2026 13:55
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.

docs: add the Zenodo DOI to README and citation

1 participant