-
Notifications
You must be signed in to change notification settings - Fork 2
License, Readme and doc slight modifications #21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
@SimonRastikian could you also move the files in the current docs folder, to its own subfolder ecdsa (or even a subfolder under that) as it was done in the original PR? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request improves documentation and licensing for the threshold signatures repository. The changes focus on enhancing clarity and providing comprehensive information about the codebase's functionality and organization.
Key changes include:
- Complete rewrite of README.md with detailed technical documentation
- Addition of NEAR One Limited copyright to the LICENSE file
- Removal of outdated documentation files (key-generation.md and CHANGELOG.md)
Reviewed Changes
Copilot reviewed 4 out of 12 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| README.md | Complete rewrite providing comprehensive documentation of ECDSA/EdDSA implementations, functionalities, and technical details |
| LICENSE | Addition of NEAR One Limited copyright alongside existing copyright |
| docs/key-generation.md | Complete removal of outdated key generation protocol documentation |
| CHANGELOG.md | Complete removal of version history changelog |
gilcu3
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just found a few minor issues. After they are fixed I am ready to approve
netrome
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This task is inherited from the simon/passive-robust-ecdsa branch (PR #15) and tends to improve upon the documentation of the whole repo.
Linked to issue #5 and #19.
More should be done in this regard but so I set the PR as draft unless I am advised to keep it as it is.