Repository navigation
docs: add OpenCite links to repository guide - #84
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.
There was a problem hiding this comment.
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.
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).
|
@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
left a comment
There was a problem hiding this comment.
Putting it back in the pro-tip boxes and clarifying the Zenodo JSON section.
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>
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
egrace479
left a comment
There was a problem hiding this comment.
Just two last formatting fixes for easier downstream integration
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
egrace479
left a comment
There was a problem hiding this comment.
Thanks! This is ready to be squashed now.
Summary
Issue
Closes #83
Testing