Nitrokey / Nitrokey/nitrokey-documentation
Mention the existence of the nitropy releases
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 36
- Forks
- 53
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 5
Description
Both here in the README.md (less of an issue if the eyes are not focused too intently on the text) and, above all, in the online documentation, the only reference made is to installing nitropy using pipx.
The existence of a release is mentioned in the online documentation only when the reader opens the Windows sub-section.
Consequently, it’s all too easy to overlook the fact that there are also regular releases of nitropy for various platforms on GitHub.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start with README.md and the online nitropy documentation page, especially the Windows subsection, and locate the existing pipx-only references. Update both documentation locations so the availability of regular GitHub releases for the relevant platforms is easy to find, then verify that the release information is consistent.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 76/100