Improve "How to Cite UXarray" docs page
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 70/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Domain
- documentation
Research direction
Start with the “How to Cite UXarray” docs page linked in the issue and review its current citation guidance. Provide a BibTeX option, make the latest-release citation current if practical, and explain when to cite a specific version versus all versions, with the specific-version guidance first.
Written by the indexing model from the issue text.
Description
The "How to Cite UXarray" docs page currently insists upon a particular string format for text, and includes many fields which need to be edited manually:
UXarray Organization. (Year). UXarray (version <version>) [Software]. Project Raijin & Project SEATS. doi:10.5281/zenodo.<doi-part-per-version>.
Text like this could still be useful in some cases, but it may be much more convenient to provide the bibtex, since if you are using LaTeX it is hard (impossible?) to control the formatting of one citation in particular, and different academic journals may each prefer different formatting for references sections.
It might also be more useful to provide an updated, autofilled version of this string for the latest UXarray release (unless it is too challenging to implement that).
The next text on the page currently provides advice about how to cite all versions. My guess is that for most use cases, it would be more important to cite the version that was actually used, instead of all versions. I would suggest that the "citing a specific version" instructions should come before the "cite all versions" instructions. Either way, the page should provide at least some brief hint about when you might want to cite a specific version (e.g., if you ran uxarray code to generate your results, cite the version you used, or at least make sure to specify which version you used) versus citing all versions (e.g. maybe use this if you are writing a review paper about software packages and refer to the uxarray package).
- Dominant language
- Python
- Stars
- 228
- Forks
- 55
- Avg merge
- 5d 1h
- Merged PRs (30d)
- 14
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from UXARRAY/uxarray
-
developer experience
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
-
new feature visualization
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
use-agent-os/agent-os#3314 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
BasedHardware/omi#15662 · 1 comment ·
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
AiursoftWeb/AnduinOS-2#19 ·