Election-Tech-Initiative / electionguard

ElectionGuard is a set of open source software components that can be used to create and publish end to end verifiable elections as well create a publishable artifact for ballot comparison audits.
https://www.electionguard.vote/
MIT License
827 stars 130 forks source link

📝. Document Verifier Construction Section of 0.95.0 Specification in Markdown #141

Open keithrfung opened 2 years ago

keithrfung commented 2 years ago

Is there an existing issue for this?

Suggestion

Document Verifier Construction Section of 0.95.0 Specification in Markdown for easy consumption on the web. This should be as close as possible to a 1 to 1 translation.

This is a particular large section and does include extra pages that sit under Verifier Construction. This includes all the number pieces like 1. Parameter Validation

Possible Implementation

Using the 0.95.0 Specification (https://github.com/microsoft/electionguard/releases/download/v0.95.0/ElectionGuard_Specification_v0_95_0.pdf) provided, create a markdown documentation page for the specific section mentioned. The page should be created within the spec/web folder

Headings

There should be only one H1 heading which will presented as the title of the page. Any other headings should be H2 or smaller according to their section.

Equations

Equations should use the built-in feature. https://squidfunk.github.io/mkdocs-material/reference/mathjax/

Tables

Tables should use the built-in feature. https://squidfunk.github.io/mkdocs-material/reference/data-tables/

Images

We want to keep the images matching the existing style of the site. These should not be copy and pasted from the document, but created preferably. If there is no other option, screenshots from the document will be accepted.

The images may be created as svg's using https://themeisle.com/illustrations/ and/or https://undraw.co/ with the color (#80CBC4) (Preferred)

OR

By using mermaid documentation: https://mermaid-js.github.io/mermaid/#/ https://squidfunk.github.io/mkdocs-material/reference/diagrams/

Green and Blue Boxes

All blue boxes should be Note admonitions. All green boxes should be Important admonitions https://squidfunk.github.io/mkdocs-material/reference/admonitions

Navigation

This is the overall navigation

--- Overview <-- Overview 
--- Structure <-- ElectionGuard Structure
--- Components <-- ElectionGuard Components (2nd ElectionGuard Components)
--- Baseline Parameters
--- Key Generation
--- Ballot Encryption
--- Ballot Aggregation
--- Verifiable Decryption
--- Election Record <-- The Election Record
--- Verifier Construction
------ Parameter Validation
------ Guardian Public-Key Validation 
------ ...
--- Applications <-- Applications to end-end verifiability and risk limited audits
--- Acknowledgements 

This specific page should be linked under web in the mkdocs.yml. An example is https://www.electionguard.vote/spec/web/1_Overview/

amarealcoder commented 2 years ago

Can I work on this?

keithrfung commented 2 years ago

@amarealcoder. Of course.

keithrfung commented 2 years ago

@amarealcoder Removing assignment, if you're still working on this. Please follow up.

ikechigriffith commented 2 years ago

Do you still need help with this?

ikechigriffith commented 2 years ago

@keithrfung assign this to me please

keithrfung commented 2 years ago

@ikechigriffith Sorry I missed these messages. I've assigned it. Although a bit late.