docs: add OpenCite links to repository guide - #84
beanbean9339 wants to merge 3 commits into
Conversation
There was a problem hiding this comment.
🟢 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.
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
left a comment
There was a problem hiding this comment.
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.
Summary
Issue
Closes #83
Testing