Skip to content

Update READMEs and documentation to reflect new publications#136

Merged
AgentElement merged 7 commits intomainfrom
docs-fixes
Jan 7, 2026
Merged

Update READMEs and documentation to reflect new publications#136
AgentElement merged 7 commits intomainfrom
docs-fixes

Conversation

@jdaymude
Copy link
Contributor

@jdaymude jdaymude commented Jan 6, 2026

This PR updates documentation related to the now-published Seet et al. (2025) paper and our own JOSS publication.

  • Updates all documentation previously referring to the arXiv version of the Seet et al. paper to now point to the published and paginated JCIM version.
  • Updates dataset generation scripts and documentation to refer to the Seet et al. code as assemblycpp-v5 instead of assembly_cpp.
  • Fixed the Zenodo shield in our README to always refer to the latest release instead of the first one specifically.
  • Adds a CITATION.cff file to the repository reflecting our own JOSS submission.
  • Completes the Citation sections in our READMEs to reflect our JOSS submission.

@jdaymude jdaymude self-assigned this Jan 6, 2026
@jdaymude jdaymude added the documentation Improvements or additions to documentation label Jan 6, 2026
@jdaymude jdaymude requested a review from AgentElement January 7, 2026 17:04
@jdaymude
Copy link
Contributor Author

jdaymude commented Jan 7, 2026

@AgentElement I'm getting a Clippy failure here on GitHub that isn't happening locally. Fixing it would be out of scope for this PR. Please advise on how you'd like this handled.

@AgentElement
Copy link
Collaborator

Best to fix the clippy lint in a separate PR and rebase.

@AgentElement AgentElement mentioned this pull request Jan 7, 2026
@AgentElement
Copy link
Collaborator

I fixed the lint errors in #137. If you rebase, the PR should be mergeable.

Copy link
Collaborator

@AgentElement AgentElement left a comment

Choose a reason for hiding this comment

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

LGTM, congratulations all!

@AgentElement AgentElement merged commit af23f60 into main Jan 7, 2026
11 checks passed
@AgentElement AgentElement deleted the docs-fixes branch January 7, 2026 19:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants