docs: 📝 add DOI #165
Merged
docs: 📝 add DOI #165
Conversation
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds DOI information to the repository documentation.
- Added a DOI badge to the README to display the digital object identifier.
- Updated the CITATION.cff file to include the DOI for citation purposes.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Added DOI badge with a link to the corresponding DOI. |
| CITATION.cff | Included DOI field for citation metadata. |
Embed citation template directly in `init` Refactors to remove the external citation template file by embedding its content directly into the `init` function. This simplifies the codebase by eliminating the need for managing an additional file, while retaining the same functionality for resetting citation details.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds persistent DOI support by embedding DOI metadata into citation files and displaying a DOI badge in the README.
- Adds a Zenodo DOI badge to README.md
- Updates CITATION.cff with a
doifield - Inlines the citation template in
init.mand clears outCITATION.cff.template - Updates the spell-check dictionary to include “Zenodo”
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| init.m | Inlined the citation template in reset_cff, including a DOI placeholder |
| README.md | Added a DOI badge linking to the Zenodo record |
| CITATION.cff | Populated the doi field with the Zenodo DOI |
| CITATION.cff.template | Removed all template content (now empty) |
| .cspell.json | Added “Zenodo” to the custom dictionary |
Comments suppressed due to low confidence (1)
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.
No description provided.