Skip to content

docs: add OpenCite links to repository guide - #84

Merged
beanbean9339 merged 13 commits into
mainfrom
feature/add-opencite-links
Oct 12, 2026
Merged

beanbean9339 merged 13 commits into
mainfrom
feature/add-opencite-links

Conversation

@beanbean9339

Copy link
Copy Markdown
Contributor

Summary

  • Added OpenCite guidance and links to the Citation section.
  • Added OpenCite guidance and links to the Zenodo Metadata section.
  • Linked researchers to OpenCite for generating standardized citation and Zenodo metadata files.

Issue

Closes #83

Testing

  • Reviewed the Markdown changes.
  • Verified that both OpenCite links point to https://imageomics.github.io/OpenCite/.
  • Confirmed that the changes are limited to the GitHub Repo Guide documentation.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

The documentation changes satisfy the linked issue and any remaining feedback is minor wording/clarity polish.

Pull request overview

This PR updates the GitHub Repo Guide documentation to point readers to OpenCite as a guided way to generate standardized citation and Zenodo metadata files, addressing issue #83.

Changes:

  • Added an OpenCite explainer and call-to-action link/button under the CITATION section.
  • Added OpenCite guidance and a call-to-action link/button under the Zenodo Metadata section.
File summaries
File Description
docs/wiki-guide/GitHub-Repo-Guide.md Adds OpenCite links/guidance to help generate CITATION.cff and .zenodo.json metadata files in the repo guide.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 2
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/wiki-guide/GitHub-Repo-Guide.md Outdated
Comment thread docs/wiki-guide/GitHub-Repo-Guide.md Outdated
Updated the link formatting for OpenCite and improved clarity in the documentation.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

@egrace479 egrace479 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think the flow is interrupted a bit with the introduction of OpenCite, so suggesting instead having a shared longer description in a footnote and packaging it in with the template descriptions + Pro Tip boxes with shorter descriptions. This also reduces redundancy for the more detailed description.

Comment thread docs/wiki-guide/GitHub-Repo-Guide.md
Comment thread docs/wiki-guide/GitHub-Repo-Guide.md Outdated

@egrace479 egrace479 left a comment •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Perfect, with two small tweaks!

One other thing I noticed while running it locally, though, is that it has a lot of these back arrows (😅 footnote challenge), which we could adjust through some special handling (remove the bolding altogether, though they'd still be there, use a custom script to only include the one from which the user clicked, or switch to footnote tooltips which show as a little hover pop-up). Such a change would be outside the scope of this PR; we do have a few other pages with footnotes referenced twice on a page.

Probably better is to just not include the footnote each time it's mentioned; limiting to the first mention in the citation section (at the top, the suggestion) and when it's mentioned in the Zenodo JSON section is probably sufficient.

Image

I tested the tooltip option and it doesn't change the footnote at the bottom of the page (might be nice to add them in--will open an issue).

Comment thread docs/wiki-guide/GitHub-Repo-Guide.md Outdated
Comment thread docs/wiki-guide/GitHub-Repo-Guide.md Outdated
@beanbean9339
beanbean9339 requested a review from egrace479 October 5, 2026 00:39
@egrace479

Copy link
Copy Markdown
Member

@beanbean9339, the notes in the admonitions should still include the link to OpenCite, I was just suggesting we don't include the footnote there.

@egrace479 egrace479 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Putting it back in the pro-tip boxes and clarifying the Zenodo JSON section.

Comment thread docs/wiki-guide/GitHub-Repo-Guide.md Outdated
Comment thread docs/wiki-guide/GitHub-Repo-Guide.md Outdated
Comment thread docs/wiki-guide/GitHub-Repo-Guide.md Outdated
beanbean9339 and others added 3 commits October 8, 2026 22:04
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
@beanbean9339
beanbean9339 requested a review from egrace479 October 9, 2026 02:07
Comment thread docs/wiki-guide/FAIR-Guide.md Outdated
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>

@egrace479 egrace479 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Just two last formatting fixes for easier downstream integration

Comment thread docs/wiki-guide/GitHub-Repo-Guide.md Outdated
Comment thread docs/wiki-guide/GitHub-Repo-Guide.md Outdated
beanbean9339 and others added 2 commits October 12, 2026 11:44
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>

@egrace479 egrace479 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks! This is ready to be squashed now.

@egrace479 egrace479 mentioned this pull request Oct 12, 2026
@beanbean9339
beanbean9339 merged commit e0ed102 into main Oct 12, 2026
1 check passed
@beanbean9339
beanbean9339 deleted the feature/add-opencite-links branch October 12, 2026 20:25
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.

Add link to OpenCite

3 participants