Skip to content

docs: add OpenCite links to repository guide - #84

Open
beanbean9339 wants to merge 3 commits into
mainfrom
feature/add-opencite-links
Open

beanbean9339 wants to merge 3 commits into
mainfrom
feature/add-opencite-links

Conversation

@beanbean9339

Copy link
Copy Markdown

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