-
Notifications
You must be signed in to change notification settings - Fork 8
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
create verifiability docs #229
Conversation
Pull Request Test Coverage Report for Build 3705131688
💛 - Coveralls |
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.
All good, just make sure to be consistent with the formatting. Especially, please leave exactly one blank line before and after titles and figures.
1d4299e
to
5f7c354
Compare
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.
The grammar of some sentences are sometimes a bit off, but overall we get the idea 👍 .
We just miss a reference to this document in the sidebar.md
, which is the menu of the documentation website, after that we can merge.
I had a partial look at the document. The content is very nice, but please fix formatting issues, try to keep short lines since is a markdown document, and fix spelling and grammar errors. If you're unsure about English I'm happy to discuss during one of our meetings. |
docs/verifiability_doc.md
Outdated
|
||
## Introduction | ||
|
||
Verifiability is an important property to allows voters to check their vote has been cast unaltered, and that it has been registered correctly in the electronic ballot box. |
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.
Verifiability is an important property to allows voters to check their vote has been cast unaltered, and that it has been registered correctly in the electronic ballot box. | |
Verifiability is an important property that enables a voter to check that their vote has been cast unaltered, and that it has been registered correctly in the electronic ballot box. | |
docs/verifiability_doc.md
Outdated
|
||
Verifiability is an important property to allows voters to check their vote has been cast unaltered, and that it has been registered correctly in the electronic ballot box. | ||
|
||
The current d-voting (version num) didn't have this design yet. The current encrypted ballot logic is shown as follows: |
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.
What is (version num)
? Before merging it would be nice to add it.
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.
Also, avoid abbreviations such as didn't
in formal documents.
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.
is shown as follows
is wrong, say either is as follows
or is shown below
, or something like that.
1e3fae6
to
5ff682b
Compare
5ff682b
to
1869527
Compare
Kudos, SonarCloud Quality Gate passed!
|
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.
Thanks 👍
create verifiability design docs.