Skip to content

Conversation

@jo-mueller
Copy link
Collaborator

@jo-mueller jo-mueller commented Nov 5, 2025

Added metadata to the jupyter book myst.yml that contains everything that's necessary to generate a CITATION.cff metadata. Whenever a new contributor opens aPR to this repo, they should add their data to the authors section in the myst.yml. A citation.cff can then be built when someone makes their first contribution.

May supersede ome/ngff#175?

Long Copilot description

This pull request introduces improvements to citation metadata, author attribution, and documentation formatting for the NGFF specification project. The main changes include adding a standardized CITATION.cff file, updating the project metadata in myst.yml to support citation export, and ensuring consistent author information across documentation and auto-generated files. Additionally, the contribution guide now instructs new contributors on how to add themselves as authors and update citation metadata.

Citation and Metadata Improvements

  • Added a comprehensive CITATION.cff file to ngff_spec/, including project abstract, keywords, license, repository links, and preferred citation details for the NGFF specification and related publications.
  • Updated ngff_spec/myst.yml to include a cff export configuration, embedding citation metadata for software and articles, and listing author and publication identifiers.

Author Attribution and Contribution Process

  • Enhanced the contribution guide in ngff_spec/contribute.md to instruct first-time contributors on adding themselves to the author list in myst.yml and on rebuilding the CITATION.cff file as part of the PR workflow.
  • Standardized author metadata in documentation and auto-generated markdown files, including examples.md, schemas.md, and files generated by pre_build.py. [1] [2] [3] [4] [5] [6] [7]

Documentation Formatting

  • Converted several documentation files (citing.md, contribute.md, examples.md, schemas.md, version_history.md) to use YAML front matter for improved consistency and compatibility with Jupyter Book and MyST Markdown. [1] [2] [3] [4] [5]

These changes streamline citation management, improve contributor recognition, and ensure consistent formatting across the NGFF specification documentation.

@jo-mueller jo-mueller added the documentation Improvements or additions to documentation label Nov 5, 2025
@github-actions
Copy link

github-actions bot commented Nov 5, 2025

Automated Review URLs

@jo-mueller jo-mueller mentioned this pull request Nov 5, 2025
5 tasks
@jo-mueller jo-mueller merged commit cb4c128 into ome:main Nov 7, 2025
3 checks passed
@jo-mueller jo-mueller deleted the author-instructions-and-citation.cff branch November 7, 2025 11:47
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